Struct ipworks::OData

Properties   Methods   Events   Config Settings   Errors  

The OData struct implements the Open Data Protocol (OData). It can be used to query, parse, and update or modify data contained within an OData service.

Syntax

ipworks::OData

Remarks

The OData Struct supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the on_ssl_server_authentication event allows you to check the server identity and other security attributes. The on_ssl_status event provides information about the SSL handshake. Additional SSL-related settings are also supported through the config method.

The OData component allows you to easily query OData services and create, update, and delete entries within a service. To query a service, you can set the service_root_uri to the service's root URI and resource_path to the collection within the service that you wish to query. Optionally you can set the Query*** properties to filter the results. query_service can then be called to retrieve the results (which can be viewed via the Entry*** properties).

Example 1. Query a Service: OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.ResourcePath = "Products" OData1.QueryService()

To create a new entry, you can set the service_root_uri to the service's root URI and resource_path to the collection within the service that you wish to add the entry to. The Entry*** properties can be set to the values you wish to use to create the entry. create_entry can then be called to create the entry.

Example 2. Create a New Entry: OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.ResourcePath = "Products" OData1.EntryProperties OData1.CreateEntry()

If you wish to update an entry, you can set the service_root_uri to the service's root URI and resource_path to the specific entry you wish to update. The Entry*** properties can be set to the values you wish to update. update_entry can then be called to update the entry.

Example 3. Update an Entry: OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.ResourcePath = "Products(1)" // Index 1 is the "Name" property. OData1.EntryProperties[1].Value = "MyNewName" OData1.UpdateEntry()

Deleting an entry requires that you first set the service_root_uri to the service's root URI and resource_path to the specific entry you wish to delete. delete_entry can then be called to delete the entry.

Example 4. Delete an Entry: OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.ResourcePath = "Products(1)" OData1.DeleteEntry()

In addition to querying a service and manipulating its containing data, the OData component also allows you to retrieve the schema (metadata document) to determine the structure of a service. After setting service_root_uri to the root URI of the service, get_schema can be called to retrieve the metadata document. The Schema*** properties will be populated upon successful retrieval of the metadata document allowing you to identify the structure of the service.

Example 5. Retrieve the Scheme: OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.GetSchema()

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorks. Due to this, the OData struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of OData when you have finished using the instance.

Property List

---

The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the struct with short descriptions. Click on the links for further details.

authorization property (OData Struct)

This property includes the Authorization string to be sent to the server.

Syntax

fn authorization(&self ) -> Result<String, IPWorksError> 
fn set_authorization(&self, value : &str) ->  Option<IPWorksError> 
fn set_authorization_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

If the authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP struct can be extended with other security schemes in addition to the authorization schemes already implemented by the struct.

The auth_scheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time user and password are set, they are Base64 encoded, and the result is put in the authorization property in the form "Basic [encoded-user-password]".

Data Type

String

auth_scheme property (OData Struct)

This property specifies the authentication scheme to use when server authentication is required.

Syntax

fn auth_scheme(&self ) -> Result<i32, IPWorksError> 
fn set_auth_scheme(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // Basic
1   // Digest
2   // Proprietary
3   // None
4   // Ntlm
5   // Negotiate
6   // OAuth

Default Value

0

Remarks

This property will tell the struct which type of authorization to perform when the user and password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the user and password properties are set, the struct will attempt HTTP Basic Authentication. If auth_scheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If auth_scheme is set to authProprietary (2), then the authorization token must be supplied through the authorization property.

If auth_scheme is set to authOAuth (6), then the authorization string must be supplied through the authorization property.

NOTE: If you set the authorization property and auth_scheme is not authProprietary or authOAuth, then the auth_scheme will be set automatically to authProprietary (2) by the struct.

For security, changing the value of this property will cause the struct to clear the values of user, password, and Authorization.

Data Type

i32

channel_author_email property (OData Struct)

This property contains the email address of the author.

Syntax

fn channel_author_email(&self ) -> Result<String, IPWorksError> 
fn set_channel_author_email(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_author_email_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the email address of the author.

Data Type

String

channel_author_name property (OData Struct)

This property contains the name of the author.

Syntax

fn channel_author_name(&self ) -> Result<String, IPWorksError> 
fn set_channel_author_name(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_author_name_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the name of the author.

Data Type

String

channel_author_uri property (OData Struct)

This property contains the uniform resource identifier (URI) of the author.

Syntax

fn channel_author_uri(&self ) -> Result<String, IPWorksError> 
fn set_channel_author_uri(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_author_uri_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the uniform resource identifier (URI) of the author.

Data Type

String

channel_category_label property (OData Struct)

This property contains a textual description of the label for the category.

Syntax

fn channel_category_label(&self ) -> Result<String, IPWorksError> 
fn set_channel_category_label(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_category_label_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains a textual description of the label for the category.

Data Type

String

channel_category_scheme property (OData Struct)

This property identifies a categorization scheme.

Syntax

fn channel_category_scheme(&self ) -> Result<String, IPWorksError> 
fn set_channel_category_scheme(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_category_scheme_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property identifies a categorization scheme.

Data Type

String

channel_category_term property (OData Struct)

This property contains the category to which the entry or feed belongs.

Syntax

fn channel_category_term(&self ) -> Result<String, IPWorksError> 
fn set_channel_category_term(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_category_term_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the category to which the entry or feed belongs.

Data Type

String

channel_contributor_email property (OData Struct)

This property contains the email address of the contributor.

Syntax

fn channel_contributor_email(&self ) -> Result<String, IPWorksError> 
fn set_channel_contributor_email(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_contributor_email_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the email address of the contributor.

Data Type

String

channel_contributor_name property (OData Struct)

This property contains the name of the contributor.

Syntax

fn channel_contributor_name(&self ) -> Result<String, IPWorksError> 
fn set_channel_contributor_name(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_contributor_name_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the name of the contributor.

Data Type

String

channel_contributor_uri property (OData Struct)

This property contains the uniform resource identifier (URI) of the contributor.

Syntax

fn channel_contributor_uri(&self ) -> Result<String, IPWorksError> 
fn set_channel_contributor_uri(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_contributor_uri_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the uniform resource identifier (URI) of the contributor.

Data Type

String

channel_generator property (OData Struct)

This property identifies the generator of the feed.

Syntax

fn channel_generator(&self ) -> Result<String, IPWorksError> 
fn set_channel_generator(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_generator_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property identifies the generator of the feed.

Data Type

String

channel_icon property (OData Struct)

This property contains a reference to the image that represents this feed.

Syntax

fn channel_icon(&self ) -> Result<String, IPWorksError> 
fn set_channel_icon(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_icon_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains a reference to the image that represents this feed.

Data Type

String

channel_id property (OData Struct)

The Id conveys a permanent, universally unique identifier for an entry or feed.

Syntax

fn channel_id(&self ) -> Result<String, IPWorksError> 
fn set_channel_id(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_id_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

The Id conveys a permanent, universally unique identifier for an entry or feed. This contains an IRI as defined by RFC 3987.

Data Type

String

channel_link_href property (OData Struct)

This property contains the location of the link.

Syntax

fn channel_link_href(&self ) -> Result<String, IPWorksError> 
fn set_channel_link_href(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_link_href_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the location of the link.

Data Type

String

channel_link_href_lang property (OData Struct)

This property contains the language of the content at the link.

Syntax

fn channel_link_href_lang(&self ) -> Result<String, IPWorksError> 
fn set_channel_link_href_lang(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_link_href_lang_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the language of the content at the link.

Data Type

String

channel_link_length property (OData Struct)

This property contains the length (in bytes) of the content at the link.

Syntax

fn channel_link_length(&self ) -> Result<String, IPWorksError> 
fn set_channel_link_length(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_link_length_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the length (in bytes) of the content at the link.

Data Type

String

channel_link_rel property (OData Struct)

This property indicates the relation of the linked content to the feed.

Syntax

fn channel_link_rel(&self ) -> Result<String, IPWorksError> 
fn set_channel_link_rel(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_link_rel_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property indicates the relation of the linked content to the feed. The following relations are defined by RFC 4287:

• alternate
• related
• self
• enclosure
• via

Data Type

String

channel_link_title property (OData Struct)

This property contains the title of the link.

Syntax

fn channel_link_title(&self ) -> Result<String, IPWorksError> 
fn set_channel_link_title(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_link_title_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the title of the link.

Data Type

String

channel_link_type property (OData Struct)

This property contains the multipurpose internet mail extension (MIME) type of the content at the link.

Syntax

fn channel_link_type(&self ) -> Result<String, IPWorksError> 
fn set_channel_link_type(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_link_type_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the multipurpose internet mail extension (MIME) type of the content at the link.

Data Type

String

channel_logo property (OData Struct)

This property contains the logo for an image that represents the feed.

Syntax

fn channel_logo(&self ) -> Result<String, IPWorksError> 
fn set_channel_logo(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_logo_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the logo for an image that represents the feed.

Data Type

String

channel_rights property (OData Struct)

This property contains information about the rights of the given feed.

Syntax

fn channel_rights(&self ) -> Result<String, IPWorksError> 
fn set_channel_rights(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_rights_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains information about the rights of the given feed.

Data Type

String

channel_rights_text_type property (OData Struct)

This property contains the text type of the rights of the feed.

Syntax

fn channel_rights_text_type(&self ) -> Result<i32, IPWorksError> 
fn set_channel_rights_text_type(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // Text
1   // HTML
2   // XHTML

Default Value

0

Remarks

This property contains the text type of the rights of the feed. Atom textual content can be HTML, XHTML, or text.

Data Type

i32

channel_subtitle property (OData Struct)

This property contains a short description of the Atom feed.

Syntax

fn channel_subtitle(&self ) -> Result<String, IPWorksError> 
fn set_channel_subtitle(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_subtitle_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains a short description of the Atom feed.

Data Type

String

channel_subtitle_text_type property (OData Struct)

This property contains the text type of the subtitle of the feed.

Syntax

fn channel_subtitle_text_type(&self ) -> Result<i32, IPWorksError> 
fn set_channel_subtitle_text_type(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // Text
1   // HTML
2   // XHTML

Default Value

0

Remarks

This property contains the text type of the subtitle of the feed. Atom textual content can be HTML, XHTML, or text.

Data Type

i32

channel_title property (OData Struct)

This property contains the title of the current Atom feed.

Syntax

fn channel_title(&self ) -> Result<String, IPWorksError> 
fn set_channel_title(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_title_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the title of the current Atom feed. Typically, the title of the channel is similar to that of the web page where the Atom content is hosted.

Data Type

String

channel_title_text_type property (OData Struct)

This property contains the text type of the title of the feed.

Syntax

fn channel_title_text_type(&self ) -> Result<i32, IPWorksError> 
fn set_channel_title_text_type(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // Text
1   // HTML
2   // XHTML

Default Value

0

Remarks

This property contains the text type of the title of the feed. Atom textual content can be HTML, XHTML, or text.

Data Type

i32

channel_updated property (OData Struct)

This property contains the date and time that the feed was updated.

Syntax

fn channel_updated(&self ) -> Result<String, IPWorksError> 
fn set_channel_updated(&self, value : &str) ->  Option<IPWorksError> 
fn set_channel_updated_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the date and time that the feed was updated.

Data Type

String

cookie_count property (OData Struct)

The number of records in the Cookie arrays.

Syntax

fn cookie_count(&self ) -> Result<i32, IPWorksError> 
fn set_cookie_count(&self, value : i32) ->  Option<IPWorksError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• cookie_domain
• cookie_expiration
• cookie_name
• cookie_path
• cookie_secure
• cookie_value

The array indices start at 0 and end at cookie_count - 1.

Data Type

i32

cookie_domain property (OData Struct)

The domain of a received cookie.

Syntax

fn cookie_domain(&self , CookieIndex : i32) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by url_server as the cookie domain.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only.

Data Type

String

cookie_expiration property (OData Struct)

An expiration time for the cookie (if provided by the server).

Syntax

fn cookie_expiration(&self , CookieIndex : i32) -> Result<String, IPWorksError> 

Default Value

""

Remarks

An expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only.

Data Type

String

cookie_name property (OData Struct)

The name of the cookie.

Syntax

fn cookie_name(&self , CookieIndex : i32) -> Result<String, IPWorksError> 
fn set_cookie_name(&self, CookieIndex : i32, value : &str) ->  Option<IPWorksError> 
fn set_cookie_name_ref(&self, CookieIndex : i32, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

The name of the cookie.

This property, along with cookie_value, stores the cookie that is to be sent to the server. The on_set_cookie event displays the cookies sent by the server and their properties.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

Data Type

String

cookie_path property (OData Struct)

A path name to limit the cookie to (if provided by the server).

Syntax

fn cookie_path(&self , CookieIndex : i32) -> Result<String, IPWorksError> 

Default Value

""

Remarks

A path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by url_path as the cookie path.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only.

Data Type

String

cookie_secure property (OData Struct)

The security flag of the received cookie.

Syntax

fn cookie_secure(&self , CookieIndex : i32) -> Result<bool, IPWorksError> 

Default Value

false

Remarks

The security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only.

Data Type

bool

cookie_value property (OData Struct)

The value of the cookie.

Syntax

fn cookie_value(&self , CookieIndex : i32) -> Result<String, IPWorksError> 
fn set_cookie_value(&self, CookieIndex : i32, value : &str) ->  Option<IPWorksError> 
fn set_cookie_value_ref(&self, CookieIndex : i32, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

The value of the cookie. A corresponding value is associated with the cookie specified by cookie_name. This property holds that value.

The on_set_cookie event provides the cookies set by the server.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

Data Type

String

entry_author property (OData Struct)

This property includes the author of the current entry in an OData feed.

Syntax

fn entry_author(&self ) -> Result<String, IPWorksError> 
fn set_entry_author(&self, value : &str) ->  Option<IPWorksError> 
fn set_entry_author_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the author of the specified entry within an OData feed. This value will be populated once entry_index is set (provided that an author can be found).

This property is not applicable to OData V4 feeds.

Data Type

String

entry_count property (OData Struct)

This property includes the number of entries contained within an OData feed.

Syntax

fn entry_count(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

This property is updated to reflect the total number of entries returned within a response (whether you are retrieving a feed/entry or making changes to a feed/entry).

This property is read-only.

Data Type

i32

entry_e_tag property (OData Struct)

This property includes the ETag of the current entry in an OData feed.

Syntax

fn entry_e_tag(&self ) -> Result<String, IPWorksError> 
fn set_entry_e_tag(&self, value : &str) ->  Option<IPWorksError> 
fn set_entry_e_tag_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property is used to obtain the ETag of the specified entry within an OData feed and will be populated once the entry_index is set.

This property is also used when retrieving, updating, or deleting an entry. When EntryETag contains a nonempty string, an If-None-Match header will be sent with the entered value when query_service is called. When delete_entry or update_entry is called, an If-Match header will be sent with the entered value.

Data Type

String

entry_id property (OData Struct)

This property includes the Id of the current entry in an OData feed.

Syntax

fn entry_id(&self ) -> Result<String, IPWorksError> 
fn set_entry_id(&self, value : &str) ->  Option<IPWorksError> 
fn set_entry_id_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the Id of the specified entry within an OData feed. This value will be populated once entry_index is set (provided that an Id can be found).

Data Type

String

entry_index property (OData Struct)

This property includes the index of the current entry in an OData feed.

Syntax

fn entry_index(&self ) -> Result<i32, IPWorksError> 
fn set_entry_index(&self, value : i32) ->  Option<IPWorksError> 

Default Value

-1

Remarks

This property is used to specify an entry within a retrieved OData feed. Once set, entry_author, entry_e_tag, entry_title, entry_summary, entry_updated, entry_links, entry_properties, and resource_path will be populated with their respective values found within the entry.

This property takes index values from 0 to entry_count -1.

Setting EntryIndex to -1 will clear the entries contained by the component and also will reset entry_properties and entry_count.

Data Type

i32

entry_links_count property (OData Struct)

The number of records in the EntryLinks arrays.

Syntax

fn entry_links_count(&self ) -> Result<i32, IPWorksError> 
fn set_entry_links_count(&self, value : i32) ->  Option<IPWorksError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• entry_links_resource_path
• entry_links_title

The array indices start at 0 and end at entry_links_count - 1.

Data Type

i32

entry_links_resource_path property (OData Struct)

This property contains the resource path of the OData entry element link.

Syntax

fn entry_links_resource_path(&self , EntryLinksIndex : i32) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the resource path of the OData entry element link.

By setting this value to resource_path and calling query_service, you can retrieve the related entries of the current entry (as specified by entry_index).

The EntryLinksIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryLinksCount property.

This property is read-only.

Data Type

String

entry_links_title property (OData Struct)

This property contains the title of the OData entry element link.

Syntax

fn entry_links_title(&self , EntryLinksIndex : i32) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the title of the OData entry element link.

The EntryLinksIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryLinksCount property.

This property is read-only.

Data Type

String

entry_properties_count property (OData Struct)

The number of records in the EntryProperties arrays.

Syntax

fn entry_properties_count(&self ) -> Result<i32, IPWorksError> 
fn set_entry_properties_count(&self, value : i32) ->  Option<IPWorksError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• entry_properties_attributes
• entry_properties_is_null
• entry_properties_name
• entry_properties_schema_type
• entry_properties_value
• entry_properties_xpath

The array indices start at 0 and end at entry_properties_count - 1.

Data Type

i32

entry_properties_attributes property (OData Struct)

This property contains a space-separated list of attributes (name-value pairs) contained within an OData entry element.

Syntax

fn entry_properties_attributes(&self , EntryPropertiesIndex : i32) -> Result<String, IPWorksError> 
fn set_entry_properties_attributes(&self, EntryPropertiesIndex : i32, value : &str) ->  Option<IPWorksError> 
fn set_entry_properties_attributes_ref(&self, EntryPropertiesIndex : i32, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains a space-separated list of attributes (name-value pairs) contained within an OData entry element. Such as name1="value1" name2="value2".

The EntryPropertiesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryPropertiesCount property.

Data Type

String

entry_properties_is_null property (OData Struct)

This property indicates whether a property value of a primitive type is null.

Syntax

fn entry_properties_is_null(&self , EntryPropertiesIndex : i32) -> Result<bool, IPWorksError> 
fn set_entry_properties_is_null(&self, EntryPropertiesIndex : i32, value : bool) ->  Option<IPWorksError> 

Default Value

false

Remarks

This property indicates whether a property value of a primitive type is null.

The EntryPropertiesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryPropertiesCount property.

Data Type

bool

entry_properties_name property (OData Struct)

This property contains the name of the OData entry element.

Syntax

fn entry_properties_name(&self , EntryPropertiesIndex : i32) -> Result<String, IPWorksError> 
fn set_entry_properties_name(&self, EntryPropertiesIndex : i32, value : &str) ->  Option<IPWorksError> 
fn set_entry_properties_name_ref(&self, EntryPropertiesIndex : i32, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the name of the OData entry element.

NOTE: For properties derived from a complex type, the name of the property and its subproperty will be separated by a slash (/). For example, let's say you have a property called MailingAddress that is derived from a complex type called Address. The Address complex type contains a property called City. This particular property will be returned as MailingAddress/City.

Setting this property to an empty string before calling update_entry will result in the item not being sent in the update request, thus removing it from the OData entry.

The EntryPropertiesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryPropertiesCount property.

Data Type

String

entry_properties_schema_type property (OData Struct)

This property contains the type of the OData schema property.

Syntax

fn entry_properties_schema_type(&self , EntryPropertiesIndex : i32) -> Result<String, IPWorksError> 
fn set_entry_properties_schema_type(&self, EntryPropertiesIndex : i32, value : &str) ->  Option<IPWorksError> 
fn set_entry_properties_schema_type_ref(&self, EntryPropertiesIndex : i32, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the type of the OData schema property.

The EntryPropertiesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryPropertiesCount property.

Data Type

String

entry_properties_value property (OData Struct)

This property contains the value of the OData entry element.

Syntax

fn entry_properties_value(&self , EntryPropertiesIndex : i32) -> Result<String, IPWorksError> 
fn set_entry_properties_value(&self, EntryPropertiesIndex : i32, value : &str) ->  Option<IPWorksError> 
fn set_entry_properties_value_ref(&self, EntryPropertiesIndex : i32, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the value of the OData entry element.

The EntryPropertiesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryPropertiesCount property.

Data Type

String

entry_properties_xpath property (OData Struct)

This property contains the XPath of the OData entry property.

Syntax

fn entry_properties_xpath(&self , EntryPropertiesIndex : i32) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the XPath of the OData entry property. xpath or can be used within update_property to update a specific property.

The EntryPropertiesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryPropertiesCount property.

This property is read-only.

Data Type

String

entry_summary property (OData Struct)

This property includes a summary of the current entry in an OData feed.

Syntax

fn entry_summary(&self ) -> Result<String, IPWorksError> 
fn set_entry_summary(&self, value : &str) ->  Option<IPWorksError> 
fn set_entry_summary_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the summary of a specified entry within an OData feed. This value will be populated once entry_index is set (provided that a summary can be found).

This property is not applicable to OData V4 feeds.

Data Type

String

entry_title property (OData Struct)

This property includes the title of the current entry in an OData feed.

Syntax

fn entry_title(&self ) -> Result<String, IPWorksError> 
fn set_entry_title(&self, value : &str) ->  Option<IPWorksError> 
fn set_entry_title_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the title of a specified entry within an OData feed. This value will be populated once entry_index is set (provided that a title can be found).

Data Type

String

entry_type property (OData Struct)

This property includes the entry category or type.

Syntax

fn entry_type(&self ) -> Result<String, IPWorksError> 
fn set_entry_type(&self, value : &str) ->  Option<IPWorksError> 
fn set_entry_type_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property specifies the entry category or type. When communicating with a service using OData V3, this property specifies the category element. When communicating with a service using OData V4, this property specifies the type attribute.

Data Type

String

entry_updated property (OData Struct)

This property includes the date-time when a current entry in an OData feed was updated.

Syntax

fn entry_updated(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the date-time when a specified entry within an OData feed was updated. This value will be populated once entry_index is set (provided that a data-time can be found).

This property is not applicable to OData V4 feeds.

This property is read-only.

Data Type

String

entry_xml property (OData Struct)

This property includes the raw XML of the current entry in an OData feed.

Syntax

fn entry_xml(&self ) -> Result<String, IPWorksError> 
fn set_entry_xml(&self, value : &str) ->  Option<IPWorksError> 
fn set_entry_xml_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the raw XML of a specified entry within an OData feed. This value will be populated once entry_index is set.

Data Type

String

firewall_auto_detect property (OData Struct)

Whether to automatically detect and use firewall system settings, if available.

Syntax

fn firewall_auto_detect(&self ) -> Result<bool, IPWorksError> 
fn set_firewall_auto_detect(&self, value : bool) ->  Option<IPWorksError> 

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

bool

firewall_type property (OData Struct)

The type of firewall to connect through.

Syntax

fn firewall_type(&self ) -> Result<i32, IPWorksError> 
fn set_firewall_type(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // None
1   // Tunnel
2   // SOCKS4
3   // SOCKS5
10   // SOCKS4A

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

i32

firewall_host property (OData Struct)

The name or IP address of the firewall (optional).

Syntax

fn firewall_host(&self ) -> Result<String, IPWorksError> 
fn set_firewall_host(&self, value : &str) ->  Option<IPWorksError> 
fn set_firewall_host_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the struct fails with an error.

Data Type

String

firewall_password property (OData Struct)

A password if authentication is to be used when connecting through the firewall.

Syntax

fn firewall_password(&self ) -> Result<String, IPWorksError> 
fn set_firewall_password(&self, value : &str) ->  Option<IPWorksError> 
fn set_firewall_password_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

Data Type

String

firewall_port property (OData Struct)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

fn firewall_port(&self ) -> Result<i32, IPWorksError> 
fn set_firewall_port(&self, value : i32) ->  Option<IPWorksError> 

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

NOTE: This property is set automatically when firewall_firewall_type is set to a valid value. See the description of the firewall_firewall_type property for details.

Data Type

i32

firewall_user property (OData Struct)

A username if authentication is to be used when connecting through a firewall.

Syntax

fn firewall_user(&self ) -> Result<String, IPWorksError> 
fn set_firewall_user(&self, value : &str) ->  Option<IPWorksError> 
fn set_firewall_user_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the struct fails with an error.

Data Type

String

idle property (OData Struct)

The current status of the struct.

Syntax

fn idle(&self ) -> Result<bool, IPWorksError> 

Default Value

true

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

bool

local_host property (OData Struct)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

fn local_host(&self ) -> Result<String, IPWorksError> 
fn set_local_host(&self, value : &str) ->  Option<IPWorksError> 
fn set_local_host_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the struct is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: local_host is not persistent. You must always set it in code, and never in the property window.

Data Type

String

o_data_version property (OData Struct)

This property includes the OData version.

Syntax

fn o_data_version(&self ) -> Result<i32, IPWorksError> 
fn set_o_data_version(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // V2
1   // V3
2   // V4
3   // Auto

Default Value

3

Remarks

This property specifies the OData version to be used in the request and expected in the response. Possible values are as follows:

• 0 (odV2)
• 1 (odv3)
• 3 (odV4)
• 4 (odAuto - default)

When set to 4 (odAuto - default), the struct will automatically determine the version used by the service and use the same version to format requests and parse responses. When calling create_entry or update_entry, if the service version is not already known from a previous operation, the struct will first query the service to determine the version.

Once the version of the service has been automatically determined, it will continue to be used until reset is called.

Data Type

i32

other_headers property (OData Struct)

Other headers as determined by the user (optional).

Syntax

fn other_headers(&self ) -> Result<String, IPWorksError> 
fn set_other_headers(&self, value : &str) ->  Option<IPWorksError> 
fn set_other_headers_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like content_type and from.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the struct beyond what is provided.

Data Type

String

other_query_options property (OData Struct)

This property includes additional query options to be used when querying a service.

Syntax

fn other_query_options(&self ) -> Result<String, IPWorksError> 
fn set_other_query_options(&self, value : &str) ->  Option<IPWorksError> 
fn set_other_query_options_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property allows you to specify additional query options that will be used when accessing a service. Query options consist of name-value pairs, and multiple entries should be separated with an "&" (i.e., name1=value1&name2=value2).

NOTE: All specified values will be appended (unaltered) to the end of the URL (generated by the combination of service_root_uri, resource_path, and any Query*** properties specified).

Data Type

String

parsed_header_count property (OData Struct)

The number of records in the ParsedHeader arrays.

Syntax

fn parsed_header_count(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_field
• parsed_header_value

The array indices start at 0 and end at parsed_header_count - 1.

This property is read-only.

Data Type

i32

parsed_header_field property (OData Struct)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

fn parsed_header_field(&self , ParsedHeaderIndex : i32) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only.

Data Type

String

parsed_header_value property (OData Struct)

This property contains the header contents.

Syntax

fn parsed_header_value(&self , ParsedHeaderIndex : i32) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the Header contents.

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only.

Data Type

String

password property (OData Struct)

This property includes a password if authentication is to be used.

Syntax

fn password(&self ) -> Result<String, IPWorksError> 
fn set_password(&self, value : &str) ->  Option<IPWorksError> 
fn set_password_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains a password if authentication is to be used. If auth_scheme is set to HTTP Basic Authentication, the user and password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If auth_scheme is set to HTTP Digest Authentication, the user and password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If auth_scheme is set to NTLM, NTLM authentication will be attempted. If auth_scheme is set to NTLM and user and password are empty, the struct will attempt to authenticate using the current user's credentials.

Data Type

String

proxy_auth_scheme property (OData Struct)

The type of authorization to perform when connecting to the proxy.

Syntax

fn proxy_auth_scheme(&self ) -> Result<i32, IPWorksError> 
fn set_proxy_auth_scheme(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // Basic
1   // Digest
2   // Proprietary
3   // None
4   // Ntlm
5   // Negotiate

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the struct will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the struct. Look at the configuration file for the struct being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

Data Type

i32

proxy_auto_detect property (OData Struct)

Whether to automatically detect and use proxy system settings, if available.

Syntax

fn proxy_auto_detect(&self ) -> Result<bool, IPWorksError> 
fn set_proxy_auto_detect(&self, value : bool) ->  Option<IPWorksError> 

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

bool

proxy_password property (OData Struct)

A password if authentication is to be used for the proxy.

Syntax

fn proxy_password(&self ) -> Result<String, IPWorksError> 
fn set_proxy_password(&self, value : &str) ->  Option<IPWorksError> 
fn set_proxy_password_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

Data Type

String

proxy_port property (OData Struct)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

fn proxy_port(&self ) -> Result<i32, IPWorksError> 
fn set_proxy_port(&self, value : i32) ->  Option<IPWorksError> 

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

Data Type

i32

proxy_server property (OData Struct)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

fn proxy_server(&self ) -> Result<String, IPWorksError> 
fn set_proxy_server(&self, value : &str) ->  Option<IPWorksError> 
fn set_proxy_server_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

proxy_ssl property (OData Struct)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

fn proxy_ssl(&self ) -> Result<i32, IPWorksError> 
fn set_proxy_ssl(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // Automatic
1   // Always
2   // Never
3   // Tunnel

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

i32

proxy_user property (OData Struct)

A username if authentication is to be used for the proxy.

Syntax

fn proxy_user(&self ) -> Result<String, IPWorksError> 
fn set_proxy_user(&self, value : &str) ->  Option<IPWorksError> 
fn set_proxy_user_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

Data Type

String

query_filter property (OData Struct)

This property selects only the entries that satisfy the specified filter (expression).

Syntax

fn query_filter(&self ) -> Result<String, IPWorksError> 
fn set_query_filter(&self, value : &str) ->  Option<IPWorksError> 
fn set_query_filter_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property allows you to specify a filter (expression) in which only the entries that satisfy it will be returned.

The following operators are supported in the expression language.

Logical Operators

Arithmetic Operators

Grouping Operators

The following functions are supported in the expression language.

String Functions

Date Functions

Math Functions

Type Functions

Data Type

String

query_order_by property (OData Struct)

This property includes the value used to order entries when querying a service.

Syntax

fn query_order_by(&self ) -> Result<String, IPWorksError> 
fn set_query_order_by(&self, value : &str) ->  Option<IPWorksError> 
fn set_query_order_by_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property allows you to specify a value by which the returned entries will be ordered after a call to query_service.

NOTE: You can specify the order by which the entries are sorted (either ascending or descending) by appending asc or desc (respectively) to your OrderBy value. For example, if you want to sort the entries by Rating in descending order you would set query_order_by to Rating desc. If a specific order (asc or desc) is not specified, the entries will be returned in ascending order.

Data Type

String

query_select property (OData Struct)

This property selects only the specified properties to be returned in an entry when querying a service.

Syntax

fn query_select(&self ) -> Result<String, IPWorksError> 
fn set_query_select(&self, value : &str) ->  Option<IPWorksError> 
fn set_query_select_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property allows you to specify the specific properties you want returned within an entry when calling query_service. The specified value should be a comma-separated list of properties (provided you wish to have more than one property returned). For example, if you wish to have only the Name and Price of each item returned you can set query_select to Name,Price.

NOTE: The specified values can be a property name, navigation property name (entry_links_title), or the "*" character, which returns all the properties for each entry.

Data Type

String

query_skip property (OData Struct)

This property includes the number of entries to skip when querying a service.

Syntax

fn query_skip(&self ) -> Result<String, IPWorksError> 
fn set_query_skip(&self, value : &str) ->  Option<IPWorksError> 
fn set_query_skip_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property allows you to specify the number of entries to skip (from the top of the list) when calling query_service. Therefore when this property set, only the remaining entries (starting with entry N+1) will be returned. The specified value should not be a value less than zero.

By default, the service you are querying will sort the entries using a scheme selected by the OData service you are querying. You can, however, use query_order_by to specify how the entries should be sorted before skipping the top N items.

This property can be used in conjunction with query_order_by and query_top to select specific entries. For example, if you wanted to select the third and fourth highest rated item you would set query_order_by to Rating desc (to order the items by Rating from highest to lowest), set query_skip to 2 (to skip the first and second items), and finally set query_top to 2 (to return only the third and fourth items).

Data Type

String

query_skip_token property (OData Struct)

This property includes the token given by an OData server when the last query result collection is too large.

Syntax

fn query_skip_token(&self ) -> Result<String, IPWorksError> 
fn set_query_skip_token(&self, value : &str) ->  Option<IPWorksError> 
fn set_query_skip_token_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

When a returned result collection is very large, it is not uncommon for the results to be broken up into multiple pages. When this occurs, a Skip Token is returned in the response and the component will populate query_skip_token with the returned value. Calling query_service again will return the next page of results.

Data Type

String

query_top property (OData Struct)

This property selects the first N entries when querying a service.

Syntax

fn query_top(&self ) -> Result<String, IPWorksError> 
fn set_query_top(&self, value : &str) ->  Option<IPWorksError> 
fn set_query_top_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property allows you to specify the number of entries (taken from the top of the list) to be returned when calling query_service. The specified value should not be a value less than zero.

By default, the service you are querying will sort the entries using a scheme selected by the OData service you are querying. You can, however, use query_order_by to specify how the entries should be sorted before selecting the top N items.

Data Type

String

resource_path property (OData Struct)

This property includes the resource path of an OData service.

Syntax

fn resource_path(&self ) -> Result<String, IPWorksError> 
fn set_resource_path(&self, value : &str) ->  Option<IPWorksError> 
fn set_resource_path_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the resource path of an OData service and is used in conjunction with service_root_uri (service_root_uri/resource_path) to query feeds and modify entries.

This property will be populated when entry_index is set. You can change the value if you wish to send the request to a different resource path.

For example, a valid resource_path for the OData sample service is Products.

Data Type

String

schema_association_contains_target property (OData Struct)

This property indicates whether the navigation property contains a target.

Syntax

fn schema_association_contains_target(&self ) -> Result<bool, IPWorksError> 

Default Value

false

Remarks

This property indicates whether the navigation property contains a target. If True, the navigation property is a containment navigation property.

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

bool

schema_association_description property (OData Struct)

This property contains the documentation long description of the OData schema association.

Syntax

fn schema_association_description(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the documentation long description of the OData schema association.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

String

schema_association_entity_type property (OData Struct)

This property contains the entity type.

Syntax

fn schema_association_entity_type(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the entity type.

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

String

schema_association_from_role property (OData Struct)

This property contains the name of the starting point of the navigation.

Syntax

fn schema_association_from_role(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the name of the starting point of the navigation.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

String

schema_association_from_role_description property (OData Struct)

This property contains the documentation long description of the OData schema FromRole association endpoint.

Syntax

fn schema_association_from_role_description(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the documentation long description of the OData schema FromRole association endpoint.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

String

schema_association_from_role_entity property (OData Struct)

This property contains the name of the entity that the FromRole association endpoint maps to.

Syntax

fn schema_association_from_role_entity(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the name of the entity that the schema_association_from_role association endpoint maps to.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

String

schema_association_from_role_multiplicity property (OData Struct)

This property contains the multiplicity of the FromRole association endpoint.

Syntax

fn schema_association_from_role_multiplicity(&self ) -> Result<i32, IPWorksError> 

Possible Values

0   // ZeroOne
1   // One
2   // Many

Default Value

0

Remarks

This property contains the multiplicity of the schema_association_from_role association endpoint. This is used along with schema_association_to_role_multiplicity to determine the cardinality of the relationship (i.e., one-to-one or one-to-many).

The available values are as follows:

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

i32

schema_association_from_role_summary property (OData Struct)

This property contains the documentation summary of the OData schema FromRole association endpoint.

Syntax

fn schema_association_from_role_summary(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the documentation summary of the OData schema FromRole association endpoint.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

String

schema_association_name property (OData Struct)

This property contains the name of the OData schema navigation property.

Syntax

fn schema_association_name(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the name of the OData schema navigation property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

String

schema_association_nullable property (OData Struct)

This property indicates whether the property defined by the schema can be a null value.

Syntax

fn schema_association_nullable(&self ) -> Result<bool, IPWorksError> 

Default Value

true

Remarks

This property indicates whether the property defined by the schema can be a null value. If False, then the object must contain a value.

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

bool

schema_association_on_delete property (OData Struct)

This property contains the delete action to be performed.

Syntax

fn schema_association_on_delete(&self ) -> Result<i32, IPWorksError> 

Possible Values

0   // None
1   // Cascade
2   // SetNull
3   // SetDefault

Default Value

0

Remarks

This property contains the delete action to be performed.

The possible values are as follows:

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

i32

schema_association_partner property (OData Struct)

This property contains the partner value identifying a navigation property (if any).

Syntax

fn schema_association_partner(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the partner value identifying a navigation property (if any).

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

String

schema_association_ref_constraint_count property (OData Struct)

This property contains the number of referential constraints.

Syntax

fn schema_association_ref_constraint_count(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

This property contains the number of referential constraints. To examine the individual referential constraints set schema_association_ref_constraint_index to a value from 0 to schema_association_ref_constraint_count -1. Example. Referential Constraints: For i = 0 to odata.SchemaAssociation.RefConstraintCount - 1 odata.SchemaAssociation.RefConstraintIndex = i; Console.Write(odata.SchemaAssociation.RefConstraintProperty); Console.Write(odata.SchemaAssociation.RefConstraintReferencedProperty); Next i

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

i32

schema_association_ref_constraint_index property (OData Struct)

This property contains the current index of the referential constraint.

Syntax

fn schema_association_ref_constraint_index(&self ) -> Result<i32, IPWorksError> 
fn set_schema_association_ref_constraint_index(&self, value : i32) ->  Option<IPWorksError> 

Default Value

0

Remarks

This property contains the current index of the referential constraint. See schema_association_ref_constraint_count for details.

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

Data Type

i32

schema_association_ref_constraint_property property (OData Struct)

This property contains the property that takes part in the referential constraint.

Syntax

fn schema_association_ref_constraint_property(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the property that takes part in the referential constraint.

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

String

schema_association_ref_constraint_referenced_property property (OData Struct)

This property contains the corresponding property of the principal entity type.

Syntax

fn schema_association_ref_constraint_referenced_property(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the corresponding property of the principal entity type.

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

String

schema_association_relationship property (OData Struct)

This property contains the name of the relationship (association) of the navigation property.

Syntax

fn schema_association_relationship(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the name of the relationship (association) of the navigation property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

String

schema_association_summary property (OData Struct)

This property contains the documentation summary of the OData schema association.

Syntax

fn schema_association_summary(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the documentation summary of the OData schema association.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

String

schema_association_to_role property (OData Struct)

This property contains the name of the endpoint of the navigation.

Syntax

fn schema_association_to_role(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the name of the endpoint of the navigation.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

String

schema_association_to_role_description property (OData Struct)

This property contains the documentation long description of the OData schema ToRole association endpoint.

Syntax

fn schema_association_to_role_description(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the documentation long description of the OData schema ToRole association endpoint.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

String

schema_association_to_role_entity property (OData Struct)

This property contains the name of the entity that the ToRole association endpoint maps to.

Syntax

fn schema_association_to_role_entity(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the name of the entity that the schema_association_to_role association endpoint maps to.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

String

schema_association_to_role_multiplicity property (OData Struct)

This property contains the multiplicity of the ToRole association endpoint.

Syntax

fn schema_association_to_role_multiplicity(&self ) -> Result<i32, IPWorksError> 

Possible Values

0   // ZeroOne
1   // One
2   // Many

Default Value

0

Remarks

This property contains the multiplicity of the schema_association_to_role association endpoint. This is used along with schema_association_from_role_multiplicity to determine the cardinality of the relationship (i.e., one-to-one or one-to-many).

The available values are as follows:

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

i32

schema_association_to_role_summary property (OData Struct)

This property contains the documentation summary of the OData schema ToRole association endpoint.

Syntax

fn schema_association_to_role_summary(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the documentation summary of the OData schema ToRole association endpoint.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only.

Data Type

String

schema_association_count property (OData Struct)

This property includes the number of navigation properties contained within an OData schema entity.

Syntax

fn schema_association_count(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

This property is updated to reflect the total number of navigation properties within the schema entity specified by schema_entity_index.

This property is read-only.

Data Type

i32

schema_association_index property (OData Struct)

This property includes the index of the current navigation property in an OData schema entity.

Syntax

fn schema_association_index(&self ) -> Result<i32, IPWorksError> 
fn set_schema_association_index(&self, value : i32) ->  Option<IPWorksError> 

Default Value

0

Remarks

This property is used to specify a navigation property within an entity (specified by schema_entity_index). Once set, schema_association will be populated.

Data Type

i32

schema_entity_description property (OData Struct)

This property contains the documentation long description of the OData schema entity.

Syntax

fn schema_entity_description(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the documentation long description of the OData schema entity.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaEntityCount property.

This property is read-only.

Data Type

String

schema_entity_name property (OData Struct)

This property contains the name of the OData schema entity.

Syntax

fn schema_entity_name(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the name of the OData schema entity.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaEntityCount property.

This property is read-only.

Data Type

String

schema_entity_summary property (OData Struct)

This property contains the documentation summary of the OData schema entity.

Syntax

fn schema_entity_summary(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the documentation summary of the OData schema entity.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaEntityCount property.

This property is read-only.

Data Type

String

schema_entity_count property (OData Struct)

This property includes the number of entities contained within an OData schema.

Syntax

fn schema_entity_count(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

This property is updated to reflect the total number of entities within a schema (retrieved via get_schema).

This property is read-only.

Data Type

i32

schema_entity_index property (OData Struct)

This property includes the index of the current entity in an OData schema.

Syntax

fn schema_entity_index(&self ) -> Result<i32, IPWorksError> 
fn set_schema_entity_index(&self, value : i32) ->  Option<IPWorksError> 

Default Value

0

Remarks

This property is used to specify an entity within a retrieved OData schema. Once set, schema_entity will be populated.

Data Type

i32

schema_keys_count property (OData Struct)

The number of records in the SchemaKeys array.

Syntax

fn schema_keys_count(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

This property is read-only.

Data Type

i32

schema_keys property (OData Struct)

This property includes the keys for a schema entity.

Syntax

fn schema_keys(&self , SchemaKeysIndex : i32) -> Result<String, IPWorksError> 

Default Value

"0"

Remarks

This property is used to obtain the keys contained within an entity for a service schema and is populated after setting schema_entity_index.

NOTE: Key values map to a property of the entity, details of which can be retrieved via schema_property.

This property is read-only.

Data Type

String

schema_property_attributes property (OData Struct)

This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element.

Syntax

fn schema_property_attributes(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element. Such as name1="value1" name2="value2".

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.

This property is read-only.

Data Type

String

schema_property_description property (OData Struct)

This property contains the documentation long description of the OData schema property.

Syntax

fn schema_property_description(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the documentation long description of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.

This property is read-only.

Data Type

String

schema_property_is_complex_type property (OData Struct)

This property indicates whether a property is derived from a complex type.

Syntax

fn schema_property_is_complex_type(&self ) -> Result<bool, IPWorksError> 

Default Value

false

Remarks

This property indicates whether a property is derived from a complex type.

When set to True, schema_type_field can be used to navigate the properties contained within the complex type.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.

This property is read-only.

Data Type

bool

schema_property_name property (OData Struct)

This property contains the Name of the OData schema property.

Syntax

fn schema_property_name(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the Name of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.

This property is read-only.

Data Type

String

schema_property_nullable property (OData Struct)

This property indicates whether a property can be null.

Syntax

fn schema_property_nullable(&self ) -> Result<bool, IPWorksError> 

Default Value

false

Remarks

This property indicates whether a property can be null.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.

This property is read-only.

Data Type

bool

schema_property_schema_type property (OData Struct)

This property contains the type of the OData schema property.

Syntax

fn schema_property_schema_type(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the type of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.

This property is read-only.

Data Type

String

schema_property_summary property (OData Struct)

This property contains the documentation summary of the OData schema property.

Syntax

fn schema_property_summary(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the documentation summary of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.

This property is read-only.

Data Type

String

schema_property_count property (OData Struct)

This property includes the number of properties contained within an OData schema entity.

Syntax

fn schema_property_count(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

This property is updated to reflect the total number of properties within the schema entity specified by schema_entity_index.

This property is read-only.

Data Type

i32

schema_property_index property (OData Struct)

This property includes the index of the current property in an OData schema entity.

Syntax

fn schema_property_index(&self ) -> Result<i32, IPWorksError> 
fn set_schema_property_index(&self, value : i32) ->  Option<IPWorksError> 

Default Value

0

Remarks

This property is used to specify a property within an entity (specified by schema_entity_index). Once set, schema_property will be populated.

Data Type

i32

schema_type_field_attributes property (OData Struct)

This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element.

Syntax

fn schema_type_field_attributes(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element. Such as name1="value1" name2="value2".

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.

This property is read-only.

Data Type

String

schema_type_field_description property (OData Struct)

This property contains the documentation long description of the OData schema property.

Syntax

fn schema_type_field_description(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the documentation long description of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.

This property is read-only.

Data Type

String

schema_type_field_is_complex_type property (OData Struct)

This property indicates whether a property is derived from a complex type.

Syntax

fn schema_type_field_is_complex_type(&self ) -> Result<bool, IPWorksError> 

Default Value

false

Remarks

This property indicates whether a property is derived from a complex type.

When set to True, schema_type_field can be used to navigate the properties contained within the complex type.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.

This property is read-only.

Data Type

bool

schema_type_field_name property (OData Struct)

This property contains the Name of the OData schema property.

Syntax

fn schema_type_field_name(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the Name of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.

This property is read-only.

Data Type

String

schema_type_field_nullable property (OData Struct)

This property indicates whether a property can be null.

Syntax

fn schema_type_field_nullable(&self ) -> Result<bool, IPWorksError> 

Default Value

false

Remarks

This property indicates whether a property can be null.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.

This property is read-only.

Data Type

bool

schema_type_field_schema_type property (OData Struct)

This property contains the type of the OData schema property.

Syntax

fn schema_type_field_schema_type(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the type of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.

This property is read-only.

Data Type

String

schema_type_field_summary property (OData Struct)

This property contains the documentation summary of the OData schema property.

Syntax

fn schema_type_field_summary(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the documentation summary of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.

This property is read-only.

Data Type

String

schema_type_field_count property (OData Struct)

This property includes the number of properties contained within an OData schema complex type.

Syntax

fn schema_type_field_count(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

This property is updated to reflect the total number of fields (properties) within the schema complex type of a property. This is populated when navigating an entity's properties via schema_property_index or by explicitly setting the type via set_schema_type.

This property is read-only.

Data Type

i32

schema_type_field_index property (OData Struct)

This property includes the index of the current field (property) in an OData schema complex type.

Syntax

fn schema_type_field_index(&self ) -> Result<i32, IPWorksError> 
fn set_schema_type_field_index(&self, value : i32) ->  Option<IPWorksError> 

Default Value

0

Remarks

This property is used to specify a field (property) within a complex type. Once set, schema_type_field will be populated.

Data Type

i32

service_root_uri property (OData Struct)

This property includes the root URI of an OData service.

Syntax

fn service_root_uri(&self ) -> Result<String, IPWorksError> 
fn set_service_root_uri(&self, value : &str) ->  Option<IPWorksError> 
fn set_service_root_uri_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the root URI of an OData service. This value is used in conjunction with resource_path (service_root_uri/resource_path) to query feeds and modify entries.

Example.

The service_root_uri of the OData sample service is "http://services.odata.org/OData/OData.svc/".

Data Type

String

ssl_accept_server_cert_effective_date property (OData Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_accept_server_cert_effective_date(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_expiration_date property (OData Struct)

The date on which the certificate expires.

Syntax

fn ssl_accept_server_cert_expiration_date(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_extended_key_usage property (OData Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_accept_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint property (OData Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha1 property (OData Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha256 property (OData Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_accept_server_cert_issuer property (OData Struct)

The issuer of the certificate.

Syntax

fn ssl_accept_server_cert_issuer(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key property (OData Struct)

The private key of the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key_available property (OData Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_accept_server_cert_private_key_available(&self ) -> Result<bool, IPWorksError> 

Default Value

false

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_accept_server_cert_private_key_container property (OData Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key_container(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key property (OData Struct)

The public key of the certificate.

Syntax

fn ssl_accept_server_cert_public_key(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_algorithm property (OData Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_accept_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_length property (OData Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_accept_server_cert_public_key_length(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_accept_server_cert_serial_number property (OData Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_accept_server_cert_serial_number(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_accept_server_cert_signature_algorithm property (OData Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_accept_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_accept_server_cert_store property (OData Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_accept_server_cert_store(&self ) -> Result<Vec<u8>, IPWorksError> 
fn set_ssl_accept_server_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksError> 
fn set_ssl_accept_server_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_accept_server_cert_store_password property (OData Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_accept_server_cert_store_password(&self ) -> Result<String, IPWorksError> 
fn set_ssl_accept_server_cert_store_password(&self, value : &str) ->  Option<IPWorksError> 
fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ssl_accept_server_cert_store_type property (OData Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_accept_server_cert_store_type(&self ) -> Result<i32, IPWorksError> 
fn set_ssl_accept_server_cert_store_type(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_accept_server_cert_subject_alt_names property (OData Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_accept_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_md5 property (OData Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha1 property (OData Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha256 property (OData Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage property (OData Struct)

The text description of UsageFlags .

Syntax

fn ssl_accept_server_cert_usage(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage_flags property (OData Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_accept_server_cert_usage_flags(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_accept_server_cert_version property (OData Struct)

The certificate's version number.

Syntax

fn ssl_accept_server_cert_version(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_accept_server_cert_subject property (OData Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_accept_server_cert_subject(&self ) -> Result<String, IPWorksError> 
fn set_ssl_accept_server_cert_subject(&self, value : &str) ->  Option<IPWorksError> 
fn set_ssl_accept_server_cert_subject_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_accept_server_cert_encoded property (OData Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_accept_server_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksError> 
fn set_ssl_accept_server_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksError> 
fn set_ssl_accept_server_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

Data Type

Vec

ssl_cert_effective_date property (OData Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_cert_effective_date(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_expiration_date property (OData Struct)

The date on which the certificate expires.

Syntax

fn ssl_cert_expiration_date(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_extended_key_usage property (OData Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_cert_extended_key_usage(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_cert_fingerprint property (OData Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha1 property (OData Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha256 property (OData Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_cert_issuer property (OData Struct)

The issuer of the certificate.

Syntax

fn ssl_cert_issuer(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_cert_private_key property (OData Struct)

The private key of the certificate (if available).

Syntax

fn ssl_cert_private_key(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_cert_private_key_available property (OData Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_cert_private_key_available(&self ) -> Result<bool, IPWorksError> 

Default Value

false

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_cert_private_key_container property (OData Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_cert_private_key_container(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_cert_public_key property (OData Struct)

The public key of the certificate.

Syntax

fn ssl_cert_public_key(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_cert_public_key_algorithm property (OData Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_cert_public_key_algorithm(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_public_key_length property (OData Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_cert_public_key_length(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_cert_serial_number property (OData Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_cert_serial_number(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_cert_signature_algorithm property (OData Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_cert_signature_algorithm(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_store property (OData Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_cert_store(&self ) -> Result<Vec<u8>, IPWorksError> 
fn set_ssl_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksError> 
fn set_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_cert_store_password property (OData Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_cert_store_password(&self ) -> Result<String, IPWorksError> 
fn set_ssl_cert_store_password(&self, value : &str) ->  Option<IPWorksError> 
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ssl_cert_store_type property (OData Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_cert_store_type(&self ) -> Result<i32, IPWorksError> 
fn set_ssl_cert_store_type(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_cert_subject_alt_names property (OData Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_cert_subject_alt_names(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_md5 property (OData Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_md5(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha1 property (OData Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha256 property (OData Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_usage property (OData Struct)

The text description of UsageFlags .

Syntax

fn ssl_cert_usage(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_cert_usage_flags property (OData Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_cert_usage_flags(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_cert_version property (OData Struct)

The certificate's version number.

Syntax

fn ssl_cert_version(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_cert_subject property (OData Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_cert_subject(&self ) -> Result<String, IPWorksError> 
fn set_ssl_cert_subject(&self, value : &str) ->  Option<IPWorksError> 
fn set_ssl_cert_subject_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_cert_encoded property (OData Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksError> 
fn set_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksError> 
fn set_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

Data Type

Vec

ssl_provider property (OData Struct)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

fn ssl_provider(&self ) -> Result<i32, IPWorksError> 
fn set_ssl_provider(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // Automatic
1   // Platform
2   // Internal

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the struct will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

Additional Notes

In most cases using the default value (Automatic) is recommended. The struct will select a provider depending on the current platform.

When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

Data Type

i32

ssl_server_cert_effective_date property (OData Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_server_cert_effective_date(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_expiration_date property (OData Struct)

The date on which the certificate expires.

Syntax

fn ssl_server_cert_expiration_date(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_extended_key_usage property (OData Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint property (OData Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha1 property (OData Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha256 property (OData Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_server_cert_issuer property (OData Struct)

The issuer of the certificate.

Syntax

fn ssl_server_cert_issuer(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_server_cert_private_key property (OData Struct)

The private key of the certificate (if available).

Syntax

fn ssl_server_cert_private_key(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_server_cert_private_key_available property (OData Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_server_cert_private_key_available(&self ) -> Result<bool, IPWorksError> 

Default Value

false

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_server_cert_private_key_container property (OData Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_server_cert_private_key_container(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_server_cert_public_key property (OData Struct)

The public key of the certificate.

Syntax

fn ssl_server_cert_public_key(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_server_cert_public_key_algorithm property (OData Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_server_cert_public_key_length property (OData Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_server_cert_public_key_length(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_server_cert_serial_number property (OData Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_server_cert_serial_number(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_server_cert_signature_algorithm property (OData Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_server_cert_store property (OData Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_server_cert_store(&self ) -> Result<Vec<u8>, IPWorksError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Vec

ssl_server_cert_store_password property (OData Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_server_cert_store_password(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

ssl_server_cert_store_type property (OData Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_server_cert_store_type(&self ) -> Result<i32, IPWorksError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

i32

ssl_server_cert_subject_alt_names property (OData Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_md5 property (OData Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha1 property (OData Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha256 property (OData Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_usage property (OData Struct)

The text description of UsageFlags .

Syntax

fn ssl_server_cert_usage(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_server_cert_usage_flags property (OData Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_server_cert_usage_flags(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_server_cert_version property (OData Struct)

The certificate's version number.

Syntax

fn ssl_server_cert_version(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_server_cert_subject property (OData Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_server_cert_subject(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

ssl_server_cert_encoded property (OData Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_server_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

Data Type

Vec

timeout property (OData Struct)

The timeout for the struct.

Syntax

fn timeout(&self ) -> Result<i32, IPWorksError> 
fn set_timeout(&self, value : i32) ->  Option<IPWorksError> 

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the struct will wait for the operation to complete before returning control.

The struct will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the struct fails with an error.

NOTE: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

Data Type

i32

transferred_data property (OData Struct)

This property includes the contents of the last response from the server.

Syntax

fn transferred_data(&self ) -> Result<Vec<u8>, IPWorksError> 

Default Value

""

Remarks

This property is used to get the data of the last response from the server.

transferred_data will be populated after a successful query_service or custom_request call, provided that local_file is not set. If local_file is set, the object data will be written to the file specified.

This property is read-only.

Data Type

Vec

user property (OData Struct)

This property includes a user name if authentication is to be used.

Syntax

fn user(&self ) -> Result<String, IPWorksError> 
fn set_user(&self, value : &str) ->  Option<IPWorksError> 
fn set_user_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains a user name if authentication is to be used. If auth_scheme is set to HTTP Basic Authentication, The user and password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If auth_scheme is set to HTTP Digest Authentication, the user and password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If auth_scheme is set to NTLM, NTLM authentication will be attempted. If auth_scheme is set to NTLM, and user and password are empty, the struct will attempt to authenticate using the current user's credentials.

Data Type

String

config method (OData Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, IPWorksError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

create_entry method (OData Struct)

This method creates a new entry within the specified OData service resource.

Syntax

fn create_entry(&self) -> Result<(), IPWorksError>

Remarks

The component will use the items contained within entry_properties to create a new entry within the feed service resource by service_root_uri and resource_path (service_root_uri/resource_path).

Upon a successful creation, all previous entries contained by the component, before the create_entry call, will be cleared and replaced with the response entry data. entry_index will then be set to 0 (the first entry within the response), populating the entry_author, entry_e_tag, entry_title, entry_summary, entry_updated, entry_links, and entry_properties properties. other_headers will also be cleared and thus will need to be reset accordingly with each call made.

custom_request method (OData Struct)

This method sends a request to the specified URL using the HTTPMethod and PostData provided.

Syntax

fn custom_request(&self, http_method : &str, url : &str, post_data : &str) -> Result<(), IPWorksError>

Remarks

This method sends a custom request to the specified URL. The type of request sent is determined by http_method (e.g., POST) and the data sent are determined by post_data. If a custom request does not require data to be sent, simply set the post_data parameter to an empty string.

NOTE: All values specified are taken as entered.

other_headers can be used to specify any additional headers you would like to be sent in the custom request.

The search results are delivered in the transferred_data property, as well as through the on_transfer event. The response headers can be retrieved through the transferred_headers property as well as through the on_header event.

The struct will then attempt to parse the search results. Upon successfully parsing the response, channel will be set with their associated feed element values and entry_count will be populated with the total number of entries contained within the feed. entry_index also will be set to 1, thus populating entry_properties.

delete_entry method (OData Struct)

This method deletes an entry within an OData service resource.

Syntax

fn delete_entry(&self) -> Result<(), IPWorksError>

Remarks

The component will delete the entry, of an OData service resource, specified by service_root_uri and resource_path (service_root_uri/resource_path).

An "If-Match" header will be sent in the delete request with the value contained within entry_e_tag.

Upon a successful entry deletion, all previous entries contained by the component, before the DeleteEntry call, will be cleared. other_headers also will be cleared and thus will need to be reset accordingly with each call made.

get_entry_property method (OData Struct)

This method gets an OData entry property.

Syntax

fn get_entry_property(&self, xpath : &str) ->  Result<String, IPWorksError>

Remarks

This method is intended to extend the functionality of the OData struct and will retrieve the value of the entry property specified by xpath. xpath is the XPath of the element or attribute according to the following convention: entry[x]/element@attribute. The @attribute part is optional. When entry_index is set to an index greater than or equal to zero, a relative path also can be used: property or property@attribute. When a relative path is specified, the value of the specified xpath will be returned for the entry identified by entry_index.

entry[x] is the feed's xth entry (or any other root-level child), where the indexer x starts at 1.

property is any child of the property's element, and attribute can be any attribute of that field. If an attribute is not supplied, the get_entry_property method will return the text portion of property.

Example 1. Attribute Not Supplied: ODataControl.GetEntryProperty("entry[5]/content/properties/ID") ODataControl.GetEntryProperty("entry[5]/content/properties/ID@type")

Example 2. Relative Path: In the following example, a relative path is used to retrieve properties of the first feed entry: ODataControl.EntryIndex = 1 ODataControl.GetEntryProperty("ID") ODataControl.GetEntryProperty("ID@type") ODataControl.GetEntryProperty("Address/State")

get_schema method (OData Struct)

This method retrieves the schema for a service.

Syntax

fn get_schema(&self) -> Result<(), IPWorksError>

Remarks

This method will retrieve the schema (metadata document) of the service specified by service_root_uri.

Upon successful retrieval of the schema, set schema_entity_index to retrieve the names of the entities contained within the schema along with their keys, properties, and navigation properties.

Additional details about the schema can be retrieved via xpath.

has_xpath method (OData Struct)

This method determines whether a specific element exists in the document.

Syntax

fn has_xpath(&self, xpath : &str) ->  Result<bool, IPWorksError>

Remarks

This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it through xpath.

This method returns true if the xpath exists, and false if not.

See xpath for details on the XPath syntax.

query_service method (OData Struct)

This method queries an OData service using the specified parameters.

Syntax

fn query_service(&self) -> Result<(), IPWorksError>

Remarks

This method queries an OData feed specified by service_root_uri and resource_path (service_root_uri/resource_path) using the query options specified in the Query*** properties and other_query_options. To retrieve an OData feed, without performing any filtering, you can leave Query*** and other_query_options empty and call query_service.

The query results are delivered in the transferred_data property, as well as through the on_transfer event. The response headers can be retrieved through the parsed_headers property as well as through the on_header event.

The struct will attempt to parse the query results. Upon successfully parsing the response, channel will be set with their associated feed element values and entry_count will be populated with the total number of entries contained within the feed. entry_index will also be set to 1, thus populating entry_author, entry_e_tag, entry_title, entry_summary, entry_updated, entry_links, entry_properties, and resource_path.

reset method (OData Struct)

This method resets all of properties of the struct.

Syntax

fn reset(&self) -> Result<(), IPWorksError>

Remarks

The reset method resets all properties to the struct's default settings. This is an easy way to clear all of the property values before repopulating the OData feed.

set_entry_property method (OData Struct)

This method is used to set an OData entry property.

Syntax

fn set_entry_property(&self, xpath : &str, value : &str) -> Result<(), IPWorksError>

Remarks

This method is intended to extend functionality of the OData struct and will set the value of the entry property (specified by xpath) to the specified value. Therefore, the value of the corresponding property will be updated within entry_properties.

xpath is the XPath of the element or attribute according to the following convention: entry[x]/element. When entry_index is set to an index greater than or equal to zero, a relative path can also be used: property. When a relative path is specified, the struct will use the specified entry_index along with the property specified to update the EntryProperty value.

entry[x] is the feed's xth entry (or any other root-level child), where the indexer x starts at 1.

property is any child of the property's element.

Example 1. Set Properties: ODataControl.SetEntryProperty("entry[5]/content/properties/Name", "MyNewName") Example 2. Retrieve Properties:

The following example uses a relative path to retrieve properties of the first feed entry: ODataControl.EntryIndex = 1 ODataControl.SetEntryProperty("Name", "MyNewName") ODataControl.SetEntryProperty("Address/State", "NC")

set_schema_entity method (OData Struct)

This method sets the schema entity.

Syntax

fn set_schema_entity(&self, name : &str) -> Result<(), IPWorksError>

Remarks

The struct will set the schema entity to the name specified. Once set, you can view the keys (via schema_keys), properties (via schema_property), and navigation properties (via schema_association) contained within the specified entity.

set_schema_property method (OData Struct)

This method sets the schema property.

Syntax

fn set_schema_property(&self, name : &str) -> Result<(), IPWorksError>

Remarks

The struct will set the schema property to the name specified. Once set, you can view the details of the property (via schema_property) along with the complex type details (via schema_type_field); provided that the property is derived from the complex type.

set_schema_type method (OData Struct)

This method sets the schema type.

Syntax

fn set_schema_type(&self, name : &str) -> Result<(), IPWorksError>

Remarks

The struct will set the schema type to the name specified. Once set, you can view the details of the complex type (via schema_type_field).

update_entry method (OData Struct)

This method updates an OData entry.

Syntax

fn update_entry(&self) -> Result<(), IPWorksError>

Remarks

The struct will update the OData entry specified by service_root_uri and resource_path (service_root_uri/resource_path). It also will update the OData entry with the elements specified by entry_properties.

Upon a successful update, all previous entries contained by the component, before the update_entry call, will be cleared and replaced with the response entry data. entry_index will then be set to zero (the first entry within the response), populating the entry_author, entry_e_tag, entry_title, entry_summary, entry_updated, entry_links, entry_properties, and resource_path properties. other_headers will also be cleared and thus will need to be reset accordingly with each call made.

update_property method (OData Struct)

This method updates an OData entry property.

Syntax

fn update_property(&self, xpath : &str, value : &str) -> Result<(), IPWorksError>

Remarks

The struct will update the OData entry specified by service_root_uri and resource_path (service_root_uri/resource_path). It will update only the single entry property specified by xpath with the specified value.

Upon a successful update, all previous entries contained by the component, before the update_property call, will be cleared and replaced with the response entry data. entry_index will then be set to zero (the first entry within the response), populating the entry_author, entry_e_tag, entry_title, entry_summary, entry_updated, entry_links, entry_properties, and resource_path. other_headers will also be cleared and thus will need to be reset accordingly with each call made.

on_connected event (OData Struct)

Fired immediately after a connection completes (or fails).

Syntax

// ODataConnectedEventArgs carries the OData Connected event's parameters.
pub struct ODataConnectedEventArgs {
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// ODataConnectedEvent defines the signature of the OData Connected event's handler function.
pub trait ODataConnectedEvent {
  fn on_connected(&self, sender : OData, e : &mut ODataConnectedEventArgs);
}

impl <'a> OData<'a> {
  pub fn on_connected(&self) -> &'a dyn ODataConnectedEvent;
  pub fn set_on_connected(&mut self, value : &'a dyn ODataConnectedEvent);
  ...
}

Remarks

If the connection is made normally, status_code is 0 and description is "OK".

If the connection fails, status_code has the error code returned by the Transmission Control Protocol (TCP)/IP stack. description contains a description of this code. The value of status_code is equal to the value of the error.

Please refer to the Error Codes section for more information.

on_disconnected event (OData Struct)

Fired when a connection is closed.

Syntax

// ODataDisconnectedEventArgs carries the OData Disconnected event's parameters.
pub struct ODataDisconnectedEventArgs {
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// ODataDisconnectedEvent defines the signature of the OData Disconnected event's handler function.
pub trait ODataDisconnectedEvent {
  fn on_disconnected(&self, sender : OData, e : &mut ODataDisconnectedEventArgs);
}

impl <'a> OData<'a> {
  pub fn on_disconnected(&self) -> &'a dyn ODataDisconnectedEvent;
  pub fn set_on_disconnected(&mut self, value : &'a dyn ODataDisconnectedEvent);
  ...
}

Remarks

If the connection is broken normally, status_code is 0 and description is "OK".

If the connection is broken for any other reason, status_code has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. description contains a description of this code. The value of status_code is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

on_end_transfer event (OData Struct)

This event fires when a document finishes transferring.

Syntax

// ODataEndTransferEventArgs carries the OData EndTransfer event's parameters.
pub struct ODataEndTransferEventArgs {
  fn direction(&self) -> i32
}

// ODataEndTransferEvent defines the signature of the OData EndTransfer event's handler function.
pub trait ODataEndTransferEvent {
  fn on_end_transfer(&self, sender : OData, e : &mut ODataEndTransferEventArgs);
}

impl <'a> OData<'a> {
  pub fn on_end_transfer(&self) -> &'a dyn ODataEndTransferEvent;
  pub fn set_on_end_transfer(&mut self, value : &'a dyn ODataEndTransferEvent);
  ...
}

Remarks

The on_end_transfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_entity event (OData Struct)

This event is fired once for each entity retrieved.

Syntax

// ODataEntityEventArgs carries the OData Entity event's parameters.
pub struct ODataEntityEventArgs {
  fn name(&self) -> &String
}

// ODataEntityEvent defines the signature of the OData Entity event's handler function.
pub trait ODataEntityEvent {
  fn on_entity(&self, sender : OData, e : &mut ODataEntityEventArgs);
}

impl <'a> OData<'a> {
  pub fn on_entity(&self) -> &'a dyn ODataEntityEvent;
  pub fn set_on_entity(&mut self, value : &'a dyn ODataEntityEvent);
  ...
}

Remarks

The on_entity event is fired once for each entity found when retrieving a service's schema (metadata document) through get_schema.

on_entry event (OData Struct)

This event is fired once for each entry retrieved.

Syntax

// ODataEntryEventArgs carries the OData Entry event's parameters.
pub struct ODataEntryEventArgs {
  fn id(&self) -> &String
  fn title(&self) -> &String
  fn summary(&self) -> &String
  fn e_tag(&self) -> &String
}

// ODataEntryEvent defines the signature of the OData Entry event's handler function.
pub trait ODataEntryEvent {
  fn on_entry(&self, sender : OData, e : &mut ODataEntryEventArgs);
}

impl <'a> OData<'a> {
  pub fn on_entry(&self) -> &'a dyn ODataEntryEvent;
  pub fn set_on_entry(&mut self, value : &'a dyn ODataEntryEvent);
  ...
}

Remarks

The on_entry event is fired once for each entry found in the response.

The entry properties are provided through entry_properties.

The entry links are provided through entry_links.

on_error event (OData Struct)

Fired when information is available about errors during data delivery.

Syntax

// ODataErrorEventArgs carries the OData Error event's parameters.
pub struct ODataErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// ODataErrorEvent defines the signature of the OData Error event's handler function.
pub trait ODataErrorEvent {
  fn on_error(&self, sender : OData, e : &mut ODataErrorEventArgs);
}

impl <'a> OData<'a> {
  pub fn on_error(&self) -> &'a dyn ODataErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn ODataErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The error_code parameter contains an error code, and the description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_header event (OData Struct)

Fired every time a header line comes in.

Syntax

// ODataHeaderEventArgs carries the OData Header event's parameters.
pub struct ODataHeaderEventArgs {
  fn field(&self) -> &String
  fn value(&self) -> &String
}

// ODataHeaderEvent defines the signature of the OData Header event's handler function.
pub trait ODataHeaderEvent {
  fn on_header(&self, sender : OData, e : &mut ODataHeaderEventArgs);
}

impl <'a> OData<'a> {
  pub fn on_header(&self) -> &'a dyn ODataHeaderEvent;
  pub fn set_on_header(&mut self, value : &'a dyn ODataHeaderEvent);
  ...
}

Remarks

The field parameter contains the name of the HTTP header (which is the same as it is delivered). The value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the field parameter contains "" (empty string).

on_log event (OData Struct)

Fired once for each log message.

Syntax

// ODataLogEventArgs carries the OData Log event's parameters.
pub struct ODataLogEventArgs {
  fn log_level(&self) -> i32
  fn message(&self) -> &String
  fn log_type(&self) -> &String
}

// ODataLogEvent defines the signature of the OData Log event's handler function.
pub trait ODataLogEvent {
  fn on_log(&self, sender : OData, e : &mut ODataLogEventArgs);
}

impl <'a> OData<'a> {
  pub fn on_log(&self) -> &'a dyn ODataLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn ODataLogEvent);
  ...
}

Remarks

This event is fired once for each log message generated by the struct. The verbosity is controlled by the LogLevel setting.

log_level indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

message is the log entry.

log_type identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

on_property event (OData Struct)

This event is fired once for each property found within an entity.

Syntax

// ODataPropertyEventArgs carries the OData Property event's parameters.
pub struct ODataPropertyEventArgs {
  fn name(&self) -> &String
  fn type_name(&self) -> &String
  fn nullable(&self) -> bool
}

// ODataPropertyEvent defines the signature of the OData Property event's handler function.
pub trait ODataPropertyEvent {
  fn on_property(&self, sender : OData, e : &mut ODataPropertyEventArgs);
}

impl <'a> OData<'a> {
  pub fn on_property(&self) -> &'a dyn ODataPropertyEvent;
  pub fn set_on_property(&mut self, value : &'a dyn ODataPropertyEvent);
  ...
}

Remarks

The on_property event is fired once for each property found within an entity after setting schema_entity_index.

on_set_cookie event (OData Struct)

Fired for every cookie set by the server.

Syntax

// ODataSetCookieEventArgs carries the OData SetCookie event's parameters.
pub struct ODataSetCookieEventArgs {
  fn name(&self) -> &String
  fn value(&self) -> &String
  fn expires(&self) -> &String
  fn domain(&self) -> &String
  fn path(&self) -> &String
  fn secure(&self) -> bool
}

// ODataSetCookieEvent defines the signature of the OData SetCookie event's handler function.
pub trait ODataSetCookieEvent {
  fn on_set_cookie(&self, sender : OData, e : &mut ODataSetCookieEventArgs);
}

impl <'a> OData<'a> {
  pub fn on_set_cookie(&self) -> &'a dyn ODataSetCookieEvent;
  pub fn set_on_set_cookie(&mut self, value : &'a dyn ODataSetCookieEvent);
  ...
}

Remarks

This event is fired for every Set-Cookie: header received from the HTTP server.

The name parameter contains the name of the cookie, with the corresponding value supplied in the value parameter.

The expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (url_server) as the cookie domain.

The path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path parameter will be an empty string. The convention in this case is to use the path specified in the URL (url_path) as the cookie path.

The secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

on_ssl_server_authentication event (OData Struct)

Fired after the server presents its certificate to the client.

Syntax

// ODataSSLServerAuthenticationEventArgs carries the OData SSLServerAuthentication event's parameters.
pub struct ODataSSLServerAuthenticationEventArgs {
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// ODataSSLServerAuthenticationEvent defines the signature of the OData SSLServerAuthentication event's handler function.
pub trait ODataSSLServerAuthenticationEvent {
  fn on_ssl_server_authentication(&self, sender : OData, e : &mut ODataSSLServerAuthenticationEventArgs);
}

impl <'a> OData<'a> {
  pub fn on_ssl_server_authentication(&self) -> &'a dyn ODataSSLServerAuthenticationEvent;
  pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn ODataSSLServerAuthenticationEvent);
  ...
}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When accept is False, status shows why the verification failed (otherwise, status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the accept parameter to True.

on_ssl_status event (OData Struct)

Fired when secure connection progress messages are available.

Syntax

// ODataSSLStatusEventArgs carries the OData SSLStatus event's parameters.
pub struct ODataSSLStatusEventArgs {
  fn message(&self) -> &String
}

// ODataSSLStatusEvent defines the signature of the OData SSLStatus event's handler function.
pub trait ODataSSLStatusEvent {
  fn on_ssl_status(&self, sender : OData, e : &mut ODataSSLStatusEventArgs);
}

impl <'a> OData<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn ODataSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn ODataSSLStatusEvent);
  ...
}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

on_start_transfer event (OData Struct)

This event fires when a document starts transferring (after the headers).

Syntax

// ODataStartTransferEventArgs carries the OData StartTransfer event's parameters.
pub struct ODataStartTransferEventArgs {
  fn direction(&self) -> i32
}

// ODataStartTransferEvent defines the signature of the OData StartTransfer event's handler function.
pub trait ODataStartTransferEvent {
  fn on_start_transfer(&self, sender : OData, e : &mut ODataStartTransferEventArgs);
}

impl <'a> OData<'a> {
  pub fn on_start_transfer(&self) -> &'a dyn ODataStartTransferEvent;
  pub fn set_on_start_transfer(&mut self, value : &'a dyn ODataStartTransferEvent);
  ...
}

Remarks

The on_start_transfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_status event (OData Struct)

Fired when the HTTP status line is received from the server.

Syntax

// ODataStatusEventArgs carries the OData Status event's parameters.
pub struct ODataStatusEventArgs {
  fn http_version(&self) -> &String
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// ODataStatusEvent defines the signature of the OData Status event's handler function.
pub trait ODataStatusEvent {
  fn on_status(&self, sender : OData, e : &mut ODataStatusEventArgs);
}

impl <'a> OData<'a> {
  pub fn on_status(&self) -> &'a dyn ODataStatusEvent;
  pub fn set_on_status(&mut self, value : &'a dyn ODataStatusEvent);
  ...
}

Remarks

http_version is a string containing the HTTP version string as returned from the server (e.g., "1.1").

status_code contains the HTTP status code (e.g., 200), and description the associated message returned by the server (e.g., "OK").

on_transfer event (OData Struct)

Fired while a document transfers (delivers document).

Syntax

// ODataTransferEventArgs carries the OData Transfer event's parameters.
pub struct ODataTransferEventArgs {
  fn direction(&self) -> i32
  fn bytes_transferred(&self) -> i64
  fn percent_done(&self) -> i32
  fn text(&self) -> &[u8]
}

// ODataTransferEvent defines the signature of the OData Transfer event's handler function.
pub trait ODataTransferEvent {
  fn on_transfer(&self, sender : OData, e : &mut ODataTransferEventArgs);
}

impl <'a> OData<'a> {
  pub fn on_transfer(&self) -> &'a dyn ODataTransferEvent;
  pub fn set_on_transfer(&mut self, value : &'a dyn ODataTransferEvent);
  ...
}

Remarks

The text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The bytes_transferred parameter contains the number of bytes transferred in this direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (OData Struct)

The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

OData Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (OData Struct)

OData Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors