# OData Class

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

## Class Name

**IPWorks_OData**

## Procedural Interface

```text
 ipworks_odata_open();
 ipworks_odata_close($res);
 ipworks_odata_register_callback($res, $id, $function);
 ipworks_odata_get_last_error($res);
 ipworks_odata_get_last_error_code($res);
 ipworks_odata_set($res, $id, $index, $value);
 ipworks_odata_get($res, $id, $index);
 ipworks_odata_do_config($res, $configurationstring);
 ipworks_odata_do_createentry($res);
 ipworks_odata_do_customrequest($res, $httpmethod, $url, $postdata);
 ipworks_odata_do_deleteentry($res);
 ipworks_odata_do_getentryproperty($res, $xpath);
 ipworks_odata_do_getschema($res);
 ipworks_odata_do_hasxpath($res, $xpath);
 ipworks_odata_do_queryservice($res);
 ipworks_odata_do_reset($res);
 ipworks_odata_do_setentryproperty($res, $xpath, $value);
 ipworks_odata_do_setschemaentity($res, $name);
 ipworks_odata_do_setschemaproperty($res, $name);
 ipworks_odata_do_setschematype($res, $name);
 ipworks_odata_do_updateentry($res);
 ipworks_odata_do_updateproperty($res, $xpath, $value);
```

## Remarks

The OData Class 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 [SSLServerAuthentication](#sslserverauthentication-event-ipworks_odata-class) event allows you to check the server identity and other security attributes. The [SSLStatus](#sslstatus-event-ipworks_odata-class) event provides information about the SSL handshake. Additional SSL-related settings are also supported through the [Config](#config-method-ipworks_odata-class) 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 [ServiceRootURI](#servicerooturi-property-ipworks_odata-class) to the service's root URI and [ResourcePath](#resourcepath-property-ipworks_odata-class) to the collection within the service that you wish to query. Optionally you can set the Query*** properties to filter the results. [QueryService](#queryservice-method-ipworks_odata-class) can then be called to retrieve the results (which can be viewed via the Entry*** properties).

**Example 1. Query a Service:**

```text
  OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc"
  OData1.ResourcePath = "Products"
  OData1.QueryService()
```

To create a new entry, you can set the [ServiceRootURI](#servicerooturi-property-ipworks_odata-class) to the service's root URI and [ResourcePath](#resourcepath-property-ipworks_odata-class) 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. [CreateEntry](#createentry-method-ipworks_odata-class) can then be called to create the entry.

**Example 2. Create a New Entry:**

```text
  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 [ServiceRootURI](#servicerooturi-property-ipworks_odata-class) to the service's root URI and [ResourcePath](#resourcepath-property-ipworks_odata-class) to the specific entry you wish to update. The Entry*** properties can be set to the values you wish to update. [UpdateEntry](#updateentry-method-ipworks_odata-class) can then be called to update the entry.

**Example 3. Update an Entry:**

```text
  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 [ServiceRootURI](#servicerooturi-property-ipworks_odata-class) to the service's root URI and [ResourcePath](#resourcepath-property-ipworks_odata-class) to the specific entry you wish to delete. [DeleteEntry](#deleteentry-method-ipworks_odata-class) can then be called to delete the entry.

**Example 4. Delete an Entry:**

```text
  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 [ServiceRootURI](#servicerooturi-property-ipworks_odata-class) to the root URI of the service, [GetSchema](#getschema-method-ipworks_odata-class) 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:**

```text
  OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc"
  OData1.GetSchema()
```

## Property List

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

|  |  |
| --- | --- |
| [Authorization](#authorization-property-ipworks_odata-class) | This property includes the Authorization string to be sent to the server. |
| [AuthScheme](#authscheme-property-ipworks_odata-class) | This property specifies the authentication scheme to use when server authentication is required. |
| [ChannelAuthorEmail](#channelauthoremail-property-ipworks_odata-class) | This property contains the email address of the author. |
| [ChannelAuthorName](#channelauthorname-property-ipworks_odata-class) | This property contains the name of the author. |
| [ChannelAuthorUri](#channelauthoruri-property-ipworks_odata-class) | This property contains the uniform resource identifier (URI) of the author. |
| [ChannelCategoryLabel](#channelcategorylabel-property-ipworks_odata-class) | This property contains a textual description of the label for the category. |
| [ChannelCategoryScheme](#channelcategoryscheme-property-ipworks_odata-class) | This property identifies a categorization scheme. |
| [ChannelCategoryTerm](#channelcategoryterm-property-ipworks_odata-class) | This property contains the category to which the entry or feed belongs. |
| [ChannelContributorEmail](#channelcontributoremail-property-ipworks_odata-class) | This property contains the email address of the contributor. |
| [ChannelContributorName](#channelcontributorname-property-ipworks_odata-class) | This property contains the name of the contributor. |
| [ChannelContributorUri](#channelcontributoruri-property-ipworks_odata-class) | This property contains the uniform resource identifier (URI) of the contributor. |
| [ChannelGenerator](#channelgenerator-property-ipworks_odata-class) | This property identifies the generator of the feed. |
| [ChannelIcon](#channelicon-property-ipworks_odata-class) | This property contains a reference to the image that represents this feed. |
| [ChannelId](#channelid-property-ipworks_odata-class) | The Id conveys a permanent, universally unique identifier for an entry or feed. |
| [ChannelLinkHref](#channellinkhref-property-ipworks_odata-class) | This property contains the location of the link. |
| [ChannelLinkHrefLang](#channellinkhreflang-property-ipworks_odata-class) | This property contains the language of the content at the link. |
| [ChannelLinkLength](#channellinklength-property-ipworks_odata-class) | This property contains the length (in bytes) of the content at the link. |
| [ChannelLinkRel](#channellinkrel-property-ipworks_odata-class) | This property indicates the relation of the linked content to the feed. |
| [ChannelLinkTitle](#channellinktitle-property-ipworks_odata-class) | This property contains the title of the link. |
| [ChannelLinkType](#channellinktype-property-ipworks_odata-class) | This property contains the multipurpose internet mail extension (MIME) type of the content at the link. |
| [ChannelLogo](#channellogo-property-ipworks_odata-class) | This property contains the logo for an image that represents the feed. |
| [ChannelRights](#channelrights-property-ipworks_odata-class) | This property contains information about the rights of the given feed. |
| [ChannelRightsTextType](#channelrightstexttype-property-ipworks_odata-class) | This property contains the text type of the rights of the feed. |
| [ChannelSubtitle](#channelsubtitle-property-ipworks_odata-class) | This property contains a short description of the Atom feed. |
| [ChannelSubtitleTextType](#channelsubtitletexttype-property-ipworks_odata-class) | This property contains the text type of the subtitle of the feed. |
| [ChannelTitle](#channeltitle-property-ipworks_odata-class) | This property contains the title of the current Atom feed. |
| [ChannelTitleTextType](#channeltitletexttype-property-ipworks_odata-class) | This property contains the text type of the title of the feed. |
| [ChannelUpdated](#channelupdated-property-ipworks_odata-class) | This property contains the date and time that the feed was updated. |
| [CookieCount](#cookiecount-property-ipworks_odata-class) | The number of records in the Cookie arrays. |
| [CookieDomain](#cookiedomain-property-ipworks_odata-class) | The domain of a received cookie. |
| [CookieExpiration](#cookieexpiration-property-ipworks_odata-class) | An expiration time for the cookie (if provided by the server). |
| [CookieName](#cookiename-property-ipworks_odata-class) | The name of the cookie. |
| [CookiePath](#cookiepath-property-ipworks_odata-class) | A path name to limit the cookie to (if provided by the server). |
| [CookieSecure](#cookiesecure-property-ipworks_odata-class) | The security flag of the received cookie. |
| [CookieValue](#cookievalue-property-ipworks_odata-class) | The value of the cookie. |
| [EntryAuthor](#entryauthor-property-ipworks_odata-class) | This property includes the author of the current entry in an OData feed. |
| [EntryCount](#entrycount-property-ipworks_odata-class) | This property includes the number of entries contained within an OData feed. |
| [EntryETag](#entryetag-property-ipworks_odata-class) | This property includes the ETag of the current entry in an OData feed. |
| [EntryId](#entryid-property-ipworks_odata-class) | This property includes the Id of the current entry in an OData feed. |
| [EntryIndex](#entryindex-property-ipworks_odata-class) | This property includes the index of the current entry in an OData feed. |
| [EntryLinksCount](#entrylinkscount-property-ipworks_odata-class) | The number of records in the EntryLinks arrays. |
| [EntryLinksResourcePath](#entrylinksresourcepath-property-ipworks_odata-class) | This property contains the resource path of the OData entry element link. |
| [EntryLinksTitle](#entrylinkstitle-property-ipworks_odata-class) | This property contains the title of the OData entry element link. |
| [EntryPropertiesCount](#entrypropertiescount-property-ipworks_odata-class) | The number of records in the EntryProperties arrays. |
| [EntryPropertiesAttributes](#entrypropertiesattributes-property-ipworks_odata-class) | This property contains a space-separated list of attributes (name-value pairs) contained within an OData entry element. |
| [EntryPropertiesIsNull](#entrypropertiesisnull-property-ipworks_odata-class) | This property indicates whether a property value of a primitive type is null. |
| [EntryPropertiesName](#entrypropertiesname-property-ipworks_odata-class) | This property contains the name of the OData entry element. |
| [EntryPropertiesSchemaType](#entrypropertiesschematype-property-ipworks_odata-class) | This property contains the type of the OData schema property. |
| [EntryPropertiesValue](#entrypropertiesvalue-property-ipworks_odata-class) | This property contains the value of the OData entry element. |
| [EntryPropertiesXPath](#entrypropertiesxpath-property-ipworks_odata-class) | This property contains the XPath of the OData entry property. |
| [EntrySummary](#entrysummary-property-ipworks_odata-class) | This property includes a summary of the current entry in an OData feed. |
| [EntryTitle](#entrytitle-property-ipworks_odata-class) | This property includes the title of the current entry in an OData feed. |
| [EntryType](#entrytype-property-ipworks_odata-class) | This property includes the entry category or type. |
| [EntryUpdated](#entryupdated-property-ipworks_odata-class) | This property includes the date-time when a current entry in an OData feed was updated. |
| [EntryXML](#entryxml-property-ipworks_odata-class) | This property includes the raw XML of the current entry in an OData feed. |
| [FirewallAutoDetect](#firewallautodetect-property-ipworks_odata-class) | Whether to automatically detect and use firewall system settings, if available. |
| [FirewallType](#firewalltype-property-ipworks_odata-class) | The type of firewall to connect through. |
| [FirewallHost](#firewallhost-property-ipworks_odata-class) | The name or IP address of the firewall (optional). |
| [FirewallPassword](#firewallpassword-property-ipworks_odata-class) | A password if authentication is to be used when connecting through the firewall. |
| [FirewallPort](#firewallport-property-ipworks_odata-class) | The Transmission Control Protocol (TCP) port for the firewall Host . |
| [FirewallUser](#firewalluser-property-ipworks_odata-class) | A username if authentication is to be used when connecting through a firewall. |
| [Idle](#idle-property-ipworks_odata-class) | The current status of the class. |
| [LocalHost](#localhost-property-ipworks_odata-class) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [ODataVersion](#odataversion-property-ipworks_odata-class) | This property includes the OData version. |
| [OtherHeaders](#otherheaders-property-ipworks_odata-class) | Other headers as determined by the user (optional). |
| [OtherQueryOptions](#otherqueryoptions-property-ipworks_odata-class) | This property includes additional query options to be used when querying a service. |
| [ParsedHeaderCount](#parsedheadercount-property-ipworks_odata-class) | The number of records in the ParsedHeader arrays. |
| [ParsedHeaderField](#parsedheaderfield-property-ipworks_odata-class) | This property contains the name of the HTTP header (this is the same case as it is delivered). |
| [ParsedHeaderValue](#parsedheadervalue-property-ipworks_odata-class) | This property contains the header contents. |
| [Password](#password-property-ipworks_odata-class) | This property includes a password if authentication is to be used. |
| [ProxyAuthScheme](#proxyauthscheme-property-ipworks_odata-class) | The type of authorization to perform when connecting to the proxy. |
| [ProxyAutoDetect](#proxyautodetect-property-ipworks_odata-class) | Whether to automatically detect and use proxy system settings, if available. |
| [ProxyPassword](#proxypassword-property-ipworks_odata-class) | A password if authentication is to be used for the proxy. |
| [ProxyPort](#proxyport-property-ipworks_odata-class) | The Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
| [ProxyServer](#proxyserver-property-ipworks_odata-class) | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| [ProxySSL](#proxyssl-property-ipworks_odata-class) | When to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
| [ProxyUser](#proxyuser-property-ipworks_odata-class) | A username if authentication is to be used for the proxy. |
| [QueryFilter](#queryfilter-property-ipworks_odata-class) | This property selects only the entries that satisfy the specified filter (expression). |
| [QueryOrderBy](#queryorderby-property-ipworks_odata-class) | This property includes the value used to order entries when querying a service. |
| [QuerySelect](#queryselect-property-ipworks_odata-class) | This property selects only the specified properties to be returned in an entry when querying a service. |
| [QuerySkip](#queryskip-property-ipworks_odata-class) | This property includes the number of entries to skip when querying a service. |
| [QuerySkipToken](#queryskiptoken-property-ipworks_odata-class) | This property includes the token given by an OData server when the last query result collection is too large. |
| [QueryTop](#querytop-property-ipworks_odata-class) | This property selects the first N entries when querying a service. |
| [ResourcePath](#resourcepath-property-ipworks_odata-class) | This property includes the resource path of an OData service. |
| [SchemaAssociationContainsTarget](#schemaassociationcontainstarget-property-ipworks_odata-class) | This property indicates whether the navigation property contains a target. |
| [SchemaAssociationDescription](#schemaassociationdescription-property-ipworks_odata-class) | This property contains the documentation long description of the OData schema association. |
| [SchemaAssociationEntityType](#schemaassociationentitytype-property-ipworks_odata-class) | This property contains the entity type. |
| [SchemaAssociationFromRole](#schemaassociationfromrole-property-ipworks_odata-class) | This property contains the name of the starting point of the navigation. |
| [SchemaAssociationFromRoleDescription](#schemaassociationfromroledescription-property-ipworks_odata-class) | This property contains the documentation long description of the OData schema FromRole association endpoint. |
| [SchemaAssociationFromRoleEntity](#schemaassociationfromroleentity-property-ipworks_odata-class) | This property contains the name of the entity that the FromRole association endpoint maps to. |
| [SchemaAssociationFromRoleMultiplicity](#schemaassociationfromrolemultiplicity-property-ipworks_odata-class) | This property contains the multiplicity of the FromRole association endpoint. |
| [SchemaAssociationFromRoleSummary](#schemaassociationfromrolesummary-property-ipworks_odata-class) | This property contains the documentation summary of the OData schema FromRole association endpoint. |
| [SchemaAssociationName](#schemaassociationname-property-ipworks_odata-class) | This property contains the name of the OData schema navigation property. |
| [SchemaAssociationNullable](#schemaassociationnullable-property-ipworks_odata-class) | This property indicates whether the property defined by the schema can be a null value. |
| [SchemaAssociationOnDelete](#schemaassociationondelete-property-ipworks_odata-class) | This property contains the delete action to be performed. |
| [SchemaAssociationPartner](#schemaassociationpartner-property-ipworks_odata-class) | This property contains the partner value identifying a navigation property (if any). |
| [SchemaAssociationRefConstraintCount](#schemaassociationrefconstraintcount-property-ipworks_odata-class) | This property contains the number of referential constraints. |
| [SchemaAssociationRefConstraintIndex](#schemaassociationrefconstraintindex-property-ipworks_odata-class) | This property contains the current index of the referential constraint. |
| [SchemaAssociationRefConstraintProperty](#schemaassociationrefconstraintproperty-property-ipworks_odata-class) | This property contains the property that takes part in the referential constraint. |
| [SchemaAssociationRefConstraintReferencedProperty](#schemaassociationrefconstraintreferencedproperty-property-ipworks_odata-class) | This property contains the corresponding property of the principal entity type. |
| [SchemaAssociationRelationship](#schemaassociationrelationship-property-ipworks_odata-class) | This property contains the name of the relationship (association) of the navigation property. |
| [SchemaAssociationSummary](#schemaassociationsummary-property-ipworks_odata-class) | This property contains the documentation summary of the OData schema association. |
| [SchemaAssociationToRole](#schemaassociationtorole-property-ipworks_odata-class) | This property contains the name of the endpoint of the navigation. |
| [SchemaAssociationToRoleDescription](#schemaassociationtoroledescription-property-ipworks_odata-class) | This property contains the documentation long description of the OData schema ToRole association endpoint. |
| [SchemaAssociationToRoleEntity](#schemaassociationtoroleentity-property-ipworks_odata-class) | This property contains the name of the entity that the ToRole association endpoint maps to. |
| [SchemaAssociationToRoleMultiplicity](#schemaassociationtorolemultiplicity-property-ipworks_odata-class) | This property contains the multiplicity of the ToRole association endpoint. |
| [SchemaAssociationToRoleSummary](#schemaassociationtorolesummary-property-ipworks_odata-class) | This property contains the documentation summary of the OData schema ToRole association endpoint. |
| [SchemaAssociationCount](#schemaassociationcount-property-ipworks_odata-class) | This property includes the number of navigation properties contained within an OData schema entity. |
| [SchemaAssociationIndex](#schemaassociationindex-property-ipworks_odata-class) | This property includes the index of the current navigation property in an OData schema entity. |
| [SchemaEntityDescription](#schemaentitydescription-property-ipworks_odata-class) | This property contains the documentation long description of the OData schema entity. |
| [SchemaEntityName](#schemaentityname-property-ipworks_odata-class) | This property contains the name of the OData schema entity. |
| [SchemaEntitySummary](#schemaentitysummary-property-ipworks_odata-class) | This property contains the documentation summary of the OData schema entity. |
| [SchemaEntityCount](#schemaentitycount-property-ipworks_odata-class) | This property includes the number of entities contained within an OData schema. |
| [SchemaEntityIndex](#schemaentityindex-property-ipworks_odata-class) | This property includes the index of the current entity in an OData schema. |
| [SchemaKeysCount](#schemakeyscount-property-ipworks_odata-class) | The number of records in the SchemaKeys array. |
| [SchemaKeys](#schemakeys-property-ipworks_odata-class) | This property includes the keys for a schema entity. |
| [SchemaPropertyAttributes](#schemapropertyattributes-property-ipworks_odata-class) | This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element. |
| [SchemaPropertyDescription](#schemapropertydescription-property-ipworks_odata-class) | This property contains the documentation long description of the OData schema property. |
| [SchemaPropertyIsComplexType](#schemapropertyiscomplextype-property-ipworks_odata-class) | This property indicates whether a property is derived from a complex type. |
| [SchemaPropertyName](#schemapropertyname-property-ipworks_odata-class) | This property contains the Name of the OData schema property. |
| [SchemaPropertyNullable](#schemapropertynullable-property-ipworks_odata-class) | This property indicates whether a property can be null. |
| [SchemaPropertySchemaType](#schemapropertyschematype-property-ipworks_odata-class) | This property contains the type of the OData schema property. |
| [SchemaPropertySummary](#schemapropertysummary-property-ipworks_odata-class) | This property contains the documentation summary of the OData schema property. |
| [SchemaPropertyCount](#schemapropertycount-property-ipworks_odata-class) | This property includes the number of properties contained within an OData schema entity. |
| [SchemaPropertyIndex](#schemapropertyindex-property-ipworks_odata-class) | This property includes the index of the current property in an OData schema entity. |
| [SchemaTypeFieldAttributes](#schematypefieldattributes-property-ipworks_odata-class) | This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element. |
| [SchemaTypeFieldDescription](#schematypefielddescription-property-ipworks_odata-class) | This property contains the documentation long description of the OData schema property. |
| [SchemaTypeFieldIsComplexType](#schematypefieldiscomplextype-property-ipworks_odata-class) | This property indicates whether a property is derived from a complex type. |
| [SchemaTypeFieldName](#schematypefieldname-property-ipworks_odata-class) | This property contains the Name of the OData schema property. |
| [SchemaTypeFieldNullable](#schematypefieldnullable-property-ipworks_odata-class) | This property indicates whether a property can be null. |
| [SchemaTypeFieldSchemaType](#schematypefieldschematype-property-ipworks_odata-class) | This property contains the type of the OData schema property. |
| [SchemaTypeFieldSummary](#schematypefieldsummary-property-ipworks_odata-class) | This property contains the documentation summary of the OData schema property. |
| [SchemaTypeFieldCount](#schematypefieldcount-property-ipworks_odata-class) | This property includes the number of properties contained within an OData schema complex type. |
| [SchemaTypeFieldIndex](#schematypefieldindex-property-ipworks_odata-class) | This property includes the index of the current field (property) in an OData schema complex type. |
| [ServiceRootURI](#servicerooturi-property-ipworks_odata-class) | This property includes the root URI of an OData service. |
| [SSLAcceptServerCertEffectiveDate](#sslacceptservercerteffectivedate-property-ipworks_odata-class) | The date on which this certificate becomes valid. |
| [SSLAcceptServerCertExpirationDate](#sslacceptservercertexpirationdate-property-ipworks_odata-class) | The date on which the certificate expires. |
| [SSLAcceptServerCertExtendedKeyUsage](#sslacceptservercertextendedkeyusage-property-ipworks_odata-class) | A comma-delimited list of extended key usage identifiers. |
| [SSLAcceptServerCertFingerprint](#sslacceptservercertfingerprint-property-ipworks_odata-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [SSLAcceptServerCertFingerprintSHA1](#sslacceptservercertfingerprintsha1-property-ipworks_odata-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [SSLAcceptServerCertFingerprintSHA256](#sslacceptservercertfingerprintsha256-property-ipworks_odata-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [SSLAcceptServerCertIssuer](#sslacceptservercertissuer-property-ipworks_odata-class) | The issuer of the certificate. |
| [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-ipworks_odata-class) | The private key of the certificate (if available). |
| [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-ipworks_odata-class) | Whether a PrivateKey is available for the selected certificate. |
| [SSLAcceptServerCertPrivateKeyContainer](#sslacceptservercertprivatekeycontainer-property-ipworks_odata-class) | The name of the PrivateKey container for the certificate (if available). |
| [SSLAcceptServerCertPublicKey](#sslacceptservercertpublickey-property-ipworks_odata-class) | The public key of the certificate. |
| [SSLAcceptServerCertPublicKeyAlgorithm](#sslacceptservercertpublickeyalgorithm-property-ipworks_odata-class) | The textual description of the certificate's public key algorithm. |
| [SSLAcceptServerCertPublicKeyLength](#sslacceptservercertpublickeylength-property-ipworks_odata-class) | The length of the certificate's public key (in bits). |
| [SSLAcceptServerCertSerialNumber](#sslacceptservercertserialnumber-property-ipworks_odata-class) | The serial number of the certificate encoded as a string. |
| [SSLAcceptServerCertSignatureAlgorithm](#sslacceptservercertsignaturealgorithm-property-ipworks_odata-class) | The text description of the certificate's signature algorithm. |
| [SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworks_odata-class) | The name of the certificate store for the client certificate. |
| [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-ipworks_odata-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-ipworks_odata-class) | The type of certificate store for this certificate. |
| [SSLAcceptServerCertSubjectAltNames](#sslacceptservercertsubjectaltnames-property-ipworks_odata-class) | Comma-separated lists of alternative subject names for the certificate. |
| [SSLAcceptServerCertThumbprintMD5](#sslacceptservercertthumbprintmd5-property-ipworks_odata-class) | The MD5 hash of the certificate. |
| [SSLAcceptServerCertThumbprintSHA1](#sslacceptservercertthumbprintsha1-property-ipworks_odata-class) | The SHA-1 hash of the certificate. |
| [SSLAcceptServerCertThumbprintSHA256](#sslacceptservercertthumbprintsha256-property-ipworks_odata-class) | The SHA-256 hash of the certificate. |
| [SSLAcceptServerCertUsage](#sslacceptservercertusage-property-ipworks_odata-class) | The text description of UsageFlags . |
| [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-ipworks_odata-class) | The flags that show intended use for the certificate. |
| [SSLAcceptServerCertVersion](#sslacceptservercertversion-property-ipworks_odata-class) | The certificate's version number. |
| [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworks_odata-class) | The subject of the certificate used for client authentication. |
| [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-ipworks_odata-class) | The certificate (PEM/Base64 encoded). |
| [SSLCertEffectiveDate](#sslcerteffectivedate-property-ipworks_odata-class) | The date on which this certificate becomes valid. |
| [SSLCertExpirationDate](#sslcertexpirationdate-property-ipworks_odata-class) | The date on which the certificate expires. |
| [SSLCertExtendedKeyUsage](#sslcertextendedkeyusage-property-ipworks_odata-class) | A comma-delimited list of extended key usage identifiers. |
| [SSLCertFingerprint](#sslcertfingerprint-property-ipworks_odata-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [SSLCertFingerprintSHA1](#sslcertfingerprintsha1-property-ipworks_odata-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [SSLCertFingerprintSHA256](#sslcertfingerprintsha256-property-ipworks_odata-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [SSLCertIssuer](#sslcertissuer-property-ipworks_odata-class) | The issuer of the certificate. |
| [SSLCertPrivateKey](#sslcertprivatekey-property-ipworks_odata-class) | The private key of the certificate (if available). |
| [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-ipworks_odata-class) | Whether a PrivateKey is available for the selected certificate. |
| [SSLCertPrivateKeyContainer](#sslcertprivatekeycontainer-property-ipworks_odata-class) | The name of the PrivateKey container for the certificate (if available). |
| [SSLCertPublicKey](#sslcertpublickey-property-ipworks_odata-class) | The public key of the certificate. |
| [SSLCertPublicKeyAlgorithm](#sslcertpublickeyalgorithm-property-ipworks_odata-class) | The textual description of the certificate's public key algorithm. |
| [SSLCertPublicKeyLength](#sslcertpublickeylength-property-ipworks_odata-class) | The length of the certificate's public key (in bits). |
| [SSLCertSerialNumber](#sslcertserialnumber-property-ipworks_odata-class) | The serial number of the certificate encoded as a string. |
| [SSLCertSignatureAlgorithm](#sslcertsignaturealgorithm-property-ipworks_odata-class) | The text description of the certificate's signature algorithm. |
| [SSLCertStore](#sslcertstore-property-ipworks_odata-class) | The name of the certificate store for the client certificate. |
| [SSLCertStorePassword](#sslcertstorepassword-property-ipworks_odata-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [SSLCertStoreType](#sslcertstoretype-property-ipworks_odata-class) | The type of certificate store for this certificate. |
| [SSLCertSubjectAltNames](#sslcertsubjectaltnames-property-ipworks_odata-class) | Comma-separated lists of alternative subject names for the certificate. |
| [SSLCertThumbprintMD5](#sslcertthumbprintmd5-property-ipworks_odata-class) | The MD5 hash of the certificate. |
| [SSLCertThumbprintSHA1](#sslcertthumbprintsha1-property-ipworks_odata-class) | The SHA-1 hash of the certificate. |
| [SSLCertThumbprintSHA256](#sslcertthumbprintsha256-property-ipworks_odata-class) | The SHA-256 hash of the certificate. |
| [SSLCertUsage](#sslcertusage-property-ipworks_odata-class) | The text description of UsageFlags . |
| [SSLCertUsageFlags](#sslcertusageflags-property-ipworks_odata-class) | The flags that show intended use for the certificate. |
| [SSLCertVersion](#sslcertversion-property-ipworks_odata-class) | The certificate's version number. |
| [SSLCertSubject](#sslcertsubject-property-ipworks_odata-class) | The subject of the certificate used for client authentication. |
| [SSLCertEncoded](#sslcertencoded-property-ipworks_odata-class) | The certificate (PEM/Base64 encoded). |
| [SSLProvider](#sslprovider-property-ipworks_odata-class) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| [SSLServerCertEffectiveDate](#sslservercerteffectivedate-property-ipworks_odata-class) | The date on which this certificate becomes valid. |
| [SSLServerCertExpirationDate](#sslservercertexpirationdate-property-ipworks_odata-class) | The date on which the certificate expires. |
| [SSLServerCertExtendedKeyUsage](#sslservercertextendedkeyusage-property-ipworks_odata-class) | A comma-delimited list of extended key usage identifiers. |
| [SSLServerCertFingerprint](#sslservercertfingerprint-property-ipworks_odata-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [SSLServerCertFingerprintSHA1](#sslservercertfingerprintsha1-property-ipworks_odata-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [SSLServerCertFingerprintSHA256](#sslservercertfingerprintsha256-property-ipworks_odata-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [SSLServerCertIssuer](#sslservercertissuer-property-ipworks_odata-class) | The issuer of the certificate. |
| [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ipworks_odata-class) | The private key of the certificate (if available). |
| [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-ipworks_odata-class) | Whether a PrivateKey is available for the selected certificate. |
| [SSLServerCertPrivateKeyContainer](#sslservercertprivatekeycontainer-property-ipworks_odata-class) | The name of the PrivateKey container for the certificate (if available). |
| [SSLServerCertPublicKey](#sslservercertpublickey-property-ipworks_odata-class) | The public key of the certificate. |
| [SSLServerCertPublicKeyAlgorithm](#sslservercertpublickeyalgorithm-property-ipworks_odata-class) | The textual description of the certificate's public key algorithm. |
| [SSLServerCertPublicKeyLength](#sslservercertpublickeylength-property-ipworks_odata-class) | The length of the certificate's public key (in bits). |
| [SSLServerCertSerialNumber](#sslservercertserialnumber-property-ipworks_odata-class) | The serial number of the certificate encoded as a string. |
| [SSLServerCertSignatureAlgorithm](#sslservercertsignaturealgorithm-property-ipworks_odata-class) | The text description of the certificate's signature algorithm. |
| [SSLServerCertStore](#sslservercertstore-property-ipworks_odata-class) | The name of the certificate store for the client certificate. |
| [SSLServerCertStorePassword](#sslservercertstorepassword-property-ipworks_odata-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [SSLServerCertStoreType](#sslservercertstoretype-property-ipworks_odata-class) | The type of certificate store for this certificate. |
| [SSLServerCertSubjectAltNames](#sslservercertsubjectaltnames-property-ipworks_odata-class) | Comma-separated lists of alternative subject names for the certificate. |
| [SSLServerCertThumbprintMD5](#sslservercertthumbprintmd5-property-ipworks_odata-class) | The MD5 hash of the certificate. |
| [SSLServerCertThumbprintSHA1](#sslservercertthumbprintsha1-property-ipworks_odata-class) | The SHA-1 hash of the certificate. |
| [SSLServerCertThumbprintSHA256](#sslservercertthumbprintsha256-property-ipworks_odata-class) | The SHA-256 hash of the certificate. |
| [SSLServerCertUsage](#sslservercertusage-property-ipworks_odata-class) | The text description of UsageFlags . |
| [SSLServerCertUsageFlags](#sslservercertusageflags-property-ipworks_odata-class) | The flags that show intended use for the certificate. |
| [SSLServerCertVersion](#sslservercertversion-property-ipworks_odata-class) | The certificate's version number. |
| [SSLServerCertSubject](#sslservercertsubject-property-ipworks_odata-class) | The subject of the certificate used for client authentication. |
| [SSLServerCertEncoded](#sslservercertencoded-property-ipworks_odata-class) | The certificate (PEM/Base64 encoded). |
| [Timeout](#timeout-property-ipworks_odata-class) | The timeout for the class. |
| [TransferredData](#transferreddata-property-ipworks_odata-class) | This property includes the contents of the last response from the server. |
| [User](#user-property-ipworks_odata-class) | This property includes a user name if authentication is to be used. |

## Method List

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

|  |  |
| --- | --- |
| [Config](#config-method-ipworks_odata-class) | Sets or retrieves a configuration setting. |
| [CreateEntry](#createentry-method-ipworks_odata-class) | This method creates a new entry within the specified OData service resource. |
| [CustomRequest](#customrequest-method-ipworks_odata-class) | This method sends a request to the specified URL using the HTTPMethod and PostData provided. |
| [DeleteEntry](#deleteentry-method-ipworks_odata-class) | This method deletes an entry within an OData service resource. |
| [GetEntryProperty](#getentryproperty-method-ipworks_odata-class) | This method gets an OData entry property. |
| [GetSchema](#getschema-method-ipworks_odata-class) | This method retrieves the schema for a service. |
| [HasXPath](#hasxpath-method-ipworks_odata-class) | This method determines whether a specific element exists in the document. |
| [QueryService](#queryservice-method-ipworks_odata-class) | This method queries an OData service using the specified parameters. |
| [Reset](#reset-method-ipworks_odata-class) | This method resets all of properties of the class. |
| [SetEntryProperty](#setentryproperty-method-ipworks_odata-class) | This method is used to set an OData entry property. |
| [SetSchemaEntity](#setschemaentity-method-ipworks_odata-class) | This method sets the schema entity. |
| [SetSchemaProperty](#setschemaproperty-method-ipworks_odata-class) | This method sets the schema property. |
| [SetSchemaType](#setschematype-method-ipworks_odata-class) | This method sets the schema type. |
| [UpdateEntry](#updateentry-method-ipworks_odata-class) | This method updates an OData entry. |
| [UpdateProperty](#updateproperty-method-ipworks_odata-class) | This method updates an OData entry property. |

## Event List

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

|  |  |
| --- | --- |
| [Connected](#connected-event-ipworks_odata-class) | Fired immediately after a connection completes (or fails). |
| [Disconnected](#disconnected-event-ipworks_odata-class) | Fired when a connection is closed. |
| [EndTransfer](#endtransfer-event-ipworks_odata-class) | This event fires when a document finishes transferring. |
| [Entity](#entity-event-ipworks_odata-class) | This event is fired once for each entity retrieved. |
| [Entry](#entry-event-ipworks_odata-class) | This event is fired once for each entry retrieved. |
| [Error](#error-event-ipworks_odata-class) | Fired when information is available about errors during data delivery. |
| [Header](#header-event-ipworks_odata-class) | Fired every time a header line comes in. |
| [Log](#log-event-ipworks_odata-class) | Fired once for each log message. |
| [Property](#property-event-ipworks_odata-class) | This event is fired once for each property found within an entity. |
| [SetCookie](#setcookie-event-ipworks_odata-class) | Fired for every cookie set by the server. |
| [SSLServerAuthentication](#sslserverauthentication-event-ipworks_odata-class) | Fired after the server presents its certificate to the client. |
| [SSLStatus](#sslstatus-event-ipworks_odata-class) | Fired when secure connection progress messages are available. |
| [StartTransfer](#starttransfer-event-ipworks_odata-class) | This event fires when a document starts transferring (after the headers). |
| [Status](#status-event-ipworks_odata-class) | Fired when the HTTP status line is received from the server. |
| [Transfer](#transfer-event-ipworks_odata-class) | Fired while a document transfers (delivers document). |

## Config Settings

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

|  |  |
| --- | --- |
| [EncodeResourcePath](#EncodeResourcePath) | Whether the ResourcePath is URL encoded. |
| [NameAndEmailFormat](#NameAndEmailFormat) | Determines how the data of the name and e-mail properties will be formatted. |
| [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. |
| [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. |
| [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. |
| [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| [Append](#Append) | Whether to append data to LocalFile. |
| [Authorization](#Authorization) | The Authorization string to be sent to the server. |
| [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. |
| [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. |
| [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. |
| [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the class. |
| [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. |
| [GetOn302Redirect](#GetOn302Redirect) | If set to True the class will perform a GET on the new location. |
| [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| [HTTPVersion](#HTTPVersion) | The version of HTTP used by the class. |
| [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. |
| [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. |
| [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. |
| [LogLevel](#LogLevel) | The level of detail that is logged. |
| [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. |
| [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. |
| [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). |
| [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. |
| [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. |
| [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. |
| [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). |
| [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). |
| [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. |
| [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. |
| [StatusCode](#StatusCode) | The status code of the last response from the server. |
| [StatusLine](#StatusLine) | The first line of the last response from the server. |
| [TransferredData](#TransferredData) | The contents of the last response from the server. |
| [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the class. |
| [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. |
| [TransferredRequest](#TransferredRequest) | The full request as sent by the client. |
| [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. |
| [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. |
| [UsePlatformHTTPClient](#UsePlatformHTTPClient) | Whether or not to use the platform HTTP client. |
| [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. |
| [UserAgent](#UserAgent) | Information about the user agent (browser). |
| [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. |
| [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
| [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). |
| [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. |
| [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. |
| [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. |
| [FirewallType](#FirewallType) | Determines the type of firewall to connect through. |
| [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. |
| [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| [Linger](#Linger) | When set to True, connections are terminated gracefully. |
| [LingerTime](#LingerTime) | Time in seconds to have the connection linger. |
| [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. |
| [LocalPort](#LocalPort) | The port in the local host where the class binds. |
| [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. |
| [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. |
| [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. |
| [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. |
| [UseIPv6](#UseIPv6) | Whether to use IPv6. |
| [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. |
| [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. |
| [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. |
| [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. |
| [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. |
| [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). |
| [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. |
| [SSLCACertFilePaths](#SSLCACertFilePaths) | The paths to CA certificate files on Unix/Linux. |
| [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. |
| [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. |
| [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. |
| [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. |
| [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. |
| [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. |
| [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. |
| [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. |
| [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. |
| [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. |
| [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. |
| [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. |
| [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. |
| [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. |
| [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. |
| [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. |
| [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. |
| [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. |
| [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. |
| [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [FirewallData](#FirewallData) | Used to send extra data to the firewall. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. |
| [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# Authorization Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getAuthorization();
public function setAuthorization($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 1 );
ipworks_odata_set($res, 1, $value );
```

## 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 class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The [AuthScheme](#authscheme-property-ipworks_odata-class) property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time [User](#user-property-ipworks_odata-class) and [Password](#password-property-ipworks_odata-class) 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

# AuthScheme Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getAuthScheme();
public function setAuthScheme($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 2 );
ipworks_odata_set($res, 2, $value );
```

## Possible Values

```text
ODATA_AUTHSCHEME_BASIC(0), ODATA_AUTHSCHEME_DIGEST(1), ODATA_AUTHSCHEME_PROPRIETARY(2), ODATA_AUTHSCHEME_NONE(3), ODATA_AUTHSCHEME_NTLM(4), ODATA_AUTHSCHEME_NEGOTIATE(5), ODATA_AUTHSCHEME_OAUTH(6)
```

## Default Value

0

## Remarks

This property will tell the class which type of authorization to perform when the [User](#user-property-ipworks_odata-class) and [Password](#password-property-ipworks_odata-class) 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](#user-property-ipworks_odata-class) and [Password](#password-property-ipworks_odata-class) properties are set, the class will attempt HTTP Basic Authentication. If AuthScheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token must be supplied through the [Authorization](#authorization-property-ipworks_odata-class) property.

If AuthScheme is set to authOAuth (6), then the authorization string must be supplied through the [Authorization](#authorization-property-ipworks_odata-class) property.

NOTE: If you set the [Authorization](#authorization-property-ipworks_odata-class) property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme will be set automatically to authProprietary (2) by the class.

For security, changing the value of this property will cause the class to clear the values of [User](#user-property-ipworks_odata-class), [Password](#password-property-ipworks_odata-class), and [Authorization](#Authorization).

## Data Type

Integer

# ChannelAuthorEmail Property ([IPWorks_OData](#odata-class) Class)

This property contains the email address of the author.

## Object Oriented Interface

```text
public function getChannelAuthorEmail();
public function setChannelAuthorEmail($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 3 );
ipworks_odata_set($res, 3, $value );
```

## Default Value

''

## Remarks

This property contains the email address of the author.

This property is not available at design time.

## Data Type

String

# ChannelAuthorName Property ([IPWorks_OData](#odata-class) Class)

This property contains the name of the author.

## Object Oriented Interface

```text
public function getChannelAuthorName();
public function setChannelAuthorName($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 4 );
ipworks_odata_set($res, 4, $value );
```

## Default Value

''

## Remarks

This property contains the name of the author.

This property is not available at design time.

## Data Type

String

# ChannelAuthorUri Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getChannelAuthorUri();
public function setChannelAuthorUri($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 5 );
ipworks_odata_set($res, 5, $value );
```

## Default Value

''

## Remarks

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

This property is not available at design time.

## Data Type

String

# ChannelCategoryLabel Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getChannelCategoryLabel();
public function setChannelCategoryLabel($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 6 );
ipworks_odata_set($res, 6, $value );
```

## Default Value

''

## Remarks

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

This property is not available at design time.

## Data Type

String

# ChannelCategoryScheme Property ([IPWorks_OData](#odata-class) Class)

This property identifies a categorization scheme.

## Object Oriented Interface

```text
public function getChannelCategoryScheme();
public function setChannelCategoryScheme($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 7 );
ipworks_odata_set($res, 7, $value );
```

## Default Value

''

## Remarks

This property identifies a categorization scheme.

This property is not available at design time.

## Data Type

String

# ChannelCategoryTerm Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getChannelCategoryTerm();
public function setChannelCategoryTerm($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 8 );
ipworks_odata_set($res, 8, $value );
```

## Default Value

''

## Remarks

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

This property is not available at design time.

## Data Type

String

# ChannelContributorEmail Property ([IPWorks_OData](#odata-class) Class)

This property contains the email address of the contributor.

## Object Oriented Interface

```text
public function getChannelContributorEmail();
public function setChannelContributorEmail($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 9 );
ipworks_odata_set($res, 9, $value );
```

## Default Value

''

## Remarks

This property contains the email address of the contributor.

This property is not available at design time.

## Data Type

String

# ChannelContributorName Property ([IPWorks_OData](#odata-class) Class)

This property contains the name of the contributor.

## Object Oriented Interface

```text
public function getChannelContributorName();
public function setChannelContributorName($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 10 );
ipworks_odata_set($res, 10, $value );
```

## Default Value

''

## Remarks

This property contains the name of the contributor.

This property is not available at design time.

## Data Type

String

# ChannelContributorUri Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getChannelContributorUri();
public function setChannelContributorUri($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 11 );
ipworks_odata_set($res, 11, $value );
```

## Default Value

''

## Remarks

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

This property is not available at design time.

## Data Type

String

# ChannelGenerator Property ([IPWorks_OData](#odata-class) Class)

This property identifies the generator of the feed.

## Object Oriented Interface

```text
public function getChannelGenerator();
public function setChannelGenerator($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 12 );
ipworks_odata_set($res, 12, $value );
```

## Default Value

''

## Remarks

This property identifies the generator of the feed.

This property is not available at design time.

## Data Type

String

# ChannelIcon Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getChannelIcon();
public function setChannelIcon($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 13 );
ipworks_odata_set($res, 13, $value );
```

## Default Value

''

## Remarks

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

This property is not available at design time.

## Data Type

String

# ChannelId Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getChannelId();
public function setChannelId($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 14 );
ipworks_odata_set($res, 14, $value );
```

## 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

# ChannelLinkHref Property ([IPWorks_OData](#odata-class) Class)

This property contains the location of the link.

## Object Oriented Interface

```text
public function getChannelLinkHref();
public function setChannelLinkHref($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 15 );
ipworks_odata_set($res, 15, $value );
```

## Default Value

''

## Remarks

This property contains the location of the link.

This property is not available at design time.

## Data Type

String

# ChannelLinkHrefLang Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getChannelLinkHrefLang();
public function setChannelLinkHrefLang($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 16 );
ipworks_odata_set($res, 16, $value );
```

## Default Value

''

## Remarks

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

This property is not available at design time.

## Data Type

String

# ChannelLinkLength Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getChannelLinkLength();
public function setChannelLinkLength($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 17 );
ipworks_odata_set($res, 17, $value );
```

## Default Value

''

## Remarks

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

This property is not available at design time.

## Data Type

String

# ChannelLinkRel Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getChannelLinkRel();
public function setChannelLinkRel($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 18 );
ipworks_odata_set($res, 18, $value );
```

## 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

This property is not available at design time.

## Data Type

String

# ChannelLinkTitle Property ([IPWorks_OData](#odata-class) Class)

This property contains the title of the link.

## Object Oriented Interface

```text
public function getChannelLinkTitle();
public function setChannelLinkTitle($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 19 );
ipworks_odata_set($res, 19, $value );
```

## Default Value

''

## Remarks

This property contains the title of the link.

This property is not available at design time.

## Data Type

String

# ChannelLinkType Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getChannelLinkType();
public function setChannelLinkType($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 20 );
ipworks_odata_set($res, 20, $value );
```

## Default Value

''

## Remarks

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

This property is not available at design time.

## Data Type

String

# ChannelLogo Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getChannelLogo();
public function setChannelLogo($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 21 );
ipworks_odata_set($res, 21, $value );
```

## Default Value

''

## Remarks

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

This property is not available at design time.

## Data Type

String

# ChannelRights Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getChannelRights();
public function setChannelRights($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 22 );
ipworks_odata_set($res, 22, $value );
```

## Default Value

''

## Remarks

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

This property is not available at design time.

## Data Type

String

# ChannelRightsTextType Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getChannelRightsTextType();
public function setChannelRightsTextType($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 23 );
ipworks_odata_set($res, 23, $value );
```

## Possible Values

```text
ODATA_CHANNELRIGHTSTEXTTYPE_TEXT(0), ODATA_CHANNELRIGHTSTEXTTYPE_HTML(1), ODATA_CHANNELRIGHTSTEXTTYPE_XHTML(2)
```

## 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

Integer

# ChannelSubtitle Property ([IPWorks_OData](#odata-class) Class)

This property contains a short description of the Atom feed.

## Object Oriented Interface

```text
public function getChannelSubtitle();
public function setChannelSubtitle($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 24 );
ipworks_odata_set($res, 24, $value );
```

## Default Value

''

## Remarks

This property contains a short description of the Atom feed.

## Data Type

String

# ChannelSubtitleTextType Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getChannelSubtitleTextType();
public function setChannelSubtitleTextType($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 25 );
ipworks_odata_set($res, 25, $value );
```

## Possible Values

```text
ODATA_CHANNELSUBTITLETEXTTYPE_TEXT(0), ODATA_CHANNELSUBTITLETEXTTYPE_HTML(1), ODATA_CHANNELSUBTITLETEXTTYPE_XHTML(2)
```

## 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

Integer

# ChannelTitle Property ([IPWorks_OData](#odata-class) Class)

This property contains the title of the current Atom feed.

## Object Oriented Interface

```text
public function getChannelTitle();
public function setChannelTitle($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 26 );
ipworks_odata_set($res, 26, $value );
```

## 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

# ChannelTitleTextType Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getChannelTitleTextType();
public function setChannelTitleTextType($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 27 );
ipworks_odata_set($res, 27, $value );
```

## Possible Values

```text
ODATA_CHANNELTITLETEXTTYPE_TEXT(0), ODATA_CHANNELTITLETEXTTYPE_HTML(1), ODATA_CHANNELTITLETEXTTYPE_XHTML(2)
```

## 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

Integer

# ChannelUpdated Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getChannelUpdated();
public function setChannelUpdated($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 28 );
ipworks_odata_set($res, 28, $value );
```

## Default Value

''

## Remarks

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

## Data Type

String

# CookieCount Property ([IPWorks_OData](#odata-class) Class)

The number of records in the Cookie arrays.

## Object Oriented Interface

```text
public function getCookieCount();
public function setCookieCount($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 29 );
ipworks_odata_set($res, 29, $value );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [CookieDomain](#cookiedomain-property-ipworks_odata-class)
- [CookieExpiration](#cookieexpiration-property-ipworks_odata-class)
- [CookieName](#cookiename-property-ipworks_odata-class)
- [CookiePath](#cookiepath-property-ipworks_odata-class)
- [CookieSecure](#cookiesecure-property-ipworks_odata-class)
- [CookieValue](#cookievalue-property-ipworks_odata-class)

The array indices start at *0* and end at *CookieCount - 1*.

This property is not available at design time.

## Data Type

Integer

# CookieDomain Property ([IPWorks_OData](#odata-class) Class)

The domain of a received cookie.

## Object Oriented Interface

```text
public function getCookieDomain($cookieindex);
```

## Procedural Interface

```text
ipworks_odata_get($res, 30 , $cookieindex);
```

## 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 URLServer 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](#cookiecount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CookieExpiration Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getCookieExpiration($cookieindex);
```

## Procedural Interface

```text
ipworks_odata_get($res, 31 , $cookieindex);
```

## 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](#cookiecount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CookieName Property ([IPWorks_OData](#odata-class) Class)

The name of the cookie.

## Object Oriented Interface

```text
public function getCookieName($cookieindex);
public function setCookieName($cookieindex, $value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 32 , $cookieindex);
ipworks_odata_set($res, 32, $value , $cookieindex);
```

## Default Value

''

## Remarks

The name of the cookie.

This property, along with [CookieValue](#cookievalue-property-ipworks_odata-class), stores the cookie that is to be sent to the server. The SetCookie 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](#cookiecount-property-ipworks_odata-class) property.

This property is not available at design time.

## Data Type

String

# CookiePath Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getCookiePath($cookieindex);
```

## Procedural Interface

```text
ipworks_odata_get($res, 33 , $cookieindex);
```

## 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 URLPath 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](#cookiecount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CookieSecure Property ([IPWorks_OData](#odata-class) Class)

The security flag of the received cookie.

## Object Oriented Interface

```text
public function getCookieSecure($cookieindex);
```

## Procedural Interface

```text
ipworks_odata_get($res, 34 , $cookieindex);
```

## 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](#cookiecount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

Boolean

# CookieValue Property ([IPWorks_OData](#odata-class) Class)

The value of the cookie.

## Object Oriented Interface

```text
public function getCookieValue($cookieindex);
public function setCookieValue($cookieindex, $value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 35 , $cookieindex);
ipworks_odata_set($res, 35, $value , $cookieindex);
```

## Default Value

''

## Remarks

The value of the cookie. A corresponding value is associated with the cookie specified by [CookieName](#cookiename-property-ipworks_odata-class). This property holds that value.

The SetCookie 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](#cookiecount-property-ipworks_odata-class) property.

This property is not available at design time.

## Data Type

String

# EntryAuthor Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getEntryAuthor();
public function setEntryAuthor($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 36 );
ipworks_odata_set($res, 36, $value );
```

## Default Value

''

## Remarks

This property contains the author of the specified entry within an OData feed. This value will be populated once [EntryIndex](#entryindex-property-ipworks_odata-class) is set (provided that an author can be found).

This property is not applicable to OData V4 feeds.

This property is not available at design time.

## Data Type

String

# EntryCount Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getEntryCount();
```

## Procedural Interface

```text
ipworks_odata_get($res, 37 );
```

## 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 and not available at design time.

## Data Type

Integer

# EntryETag Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getEntryETag();
public function setEntryETag($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 38 );
ipworks_odata_set($res, 38, $value );
```

## 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 [EntryIndex](#entryindex-property-ipworks_odata-class) 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 [QueryService](#queryservice-method-ipworks_odata-class) is called. When [DeleteEntry](#deleteentry-method-ipworks_odata-class) or [UpdateEntry](#updateentry-method-ipworks_odata-class) is called, an *If-Match* header will be sent with the entered value.

This property is not available at design time.

## Data Type

String

# EntryId Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getEntryId();
public function setEntryId($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 39 );
ipworks_odata_set($res, 39, $value );
```

## Default Value

''

## Remarks

This property contains the Id of the specified entry within an OData feed. This value will be populated once [EntryIndex](#entryindex-property-ipworks_odata-class) is set (provided that an Id can be found).

This property is not available at design time.

## Data Type

String

# EntryIndex Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getEntryIndex();
public function setEntryIndex($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 40 );
ipworks_odata_set($res, 40, $value );
```

## Default Value

-1

## Remarks

This property is used to specify an entry within a retrieved OData feed. Once set, [EntryAuthor](#entryauthor-property-ipworks_odata-class), [EntryETag](#entryetag-property-ipworks_odata-class), [EntryTitle](#entrytitle-property-ipworks_odata-class), [EntrySummary](#entrysummary-property-ipworks_odata-class), [EntryUpdated](#entryupdated-property-ipworks_odata-class), EntryLinks, EntryProperties, and [ResourcePath](#resourcepath-property-ipworks_odata-class) will be populated with their respective values found within the entry.

This property takes index values from 0 to [EntryCount](#entrycount-property-ipworks_odata-class) -1.

Setting EntryIndex to -1 will clear the entries contained by the component and also will reset EntryProperties and [EntryCount](#entrycount-property-ipworks_odata-class).

This property is not available at design time.

## Data Type

Integer

# EntryLinksCount Property ([IPWorks_OData](#odata-class) Class)

The number of records in the EntryLinks arrays.

## Object Oriented Interface

```text
public function getEntryLinksCount();
public function setEntryLinksCount($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 41 );
ipworks_odata_set($res, 41, $value );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [EntryLinksResourcePath](#entrylinksresourcepath-property-ipworks_odata-class)
- [EntryLinksTitle](#entrylinkstitle-property-ipworks_odata-class)

The array indices start at *0* and end at *EntryLinksCount - 1*.

This property is not available at design time.

## Data Type

Integer

# EntryLinksResourcePath Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getEntryLinksResourcePath($entrylinksindex);
```

## Procedural Interface

```text
ipworks_odata_get($res, 42 , $entrylinksindex);
```

## Default Value

''

## Remarks

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

By setting this value to [ResourcePath](#resourcepath-property-ipworks_odata-class) and calling [QueryService](#queryservice-method-ipworks_odata-class), you can retrieve the related entries of the current entry (as specified by [EntryIndex](#entryindex-property-ipworks_odata-class)).

The *$entrylinksindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [EntryLinksCount](#entrylinkscount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# EntryLinksTitle Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getEntryLinksTitle($entrylinksindex);
```

## Procedural Interface

```text
ipworks_odata_get($res, 43 , $entrylinksindex);
```

## 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](#entrylinkscount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# EntryPropertiesCount Property ([IPWorks_OData](#odata-class) Class)

The number of records in the EntryProperties arrays.

## Object Oriented Interface

```text
public function getEntryPropertiesCount();
public function setEntryPropertiesCount($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 44 );
ipworks_odata_set($res, 44, $value );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [EntryPropertiesAttributes](#entrypropertiesattributes-property-ipworks_odata-class)
- [EntryPropertiesIsNull](#entrypropertiesisnull-property-ipworks_odata-class)
- [EntryPropertiesName](#entrypropertiesname-property-ipworks_odata-class)
- [EntryPropertiesSchemaType](#entrypropertiesschematype-property-ipworks_odata-class)
- [EntryPropertiesValue](#entrypropertiesvalue-property-ipworks_odata-class)
- [EntryPropertiesXPath](#entrypropertiesxpath-property-ipworks_odata-class)

The array indices start at *0* and end at *EntryPropertiesCount - 1*.

This property is not available at design time.

## Data Type

Integer

# EntryPropertiesAttributes Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getEntryPropertiesAttributes($entrypropertiesindex);
public function setEntryPropertiesAttributes($entrypropertiesindex, $value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 45 , $entrypropertiesindex);
ipworks_odata_set($res, 45, $value , $entrypropertiesindex);
```

## 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](#entrypropertiescount-property-ipworks_odata-class) property.

This property is not available at design time.

## Data Type

String

# EntryPropertiesIsNull Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getEntryPropertiesIsNull($entrypropertiesindex);
public function setEntryPropertiesIsNull($entrypropertiesindex, $value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 46 , $entrypropertiesindex);
ipworks_odata_set($res, 46, $value , $entrypropertiesindex);
```

## 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](#entrypropertiescount-property-ipworks_odata-class) property.

This property is not available at design time.

## Data Type

Boolean

# EntryPropertiesName Property ([IPWorks_OData](#odata-class) Class)

This property contains the name of the OData entry element.

## Object Oriented Interface

```text
public function getEntryPropertiesName($entrypropertiesindex);
public function setEntryPropertiesName($entrypropertiesindex, $value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 47 , $entrypropertiesindex);
ipworks_odata_set($res, 47, $value , $entrypropertiesindex);
```

## 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 [UpdateEntry](#updateentry-method-ipworks_odata-class) 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](#entrypropertiescount-property-ipworks_odata-class) property.

This property is not available at design time.

## Data Type

String

# EntryPropertiesSchemaType Property ([IPWorks_OData](#odata-class) Class)

This property contains the type of the OData schema property.

## Object Oriented Interface

```text
public function getEntryPropertiesSchemaType($entrypropertiesindex);
public function setEntryPropertiesSchemaType($entrypropertiesindex, $value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 48 , $entrypropertiesindex);
ipworks_odata_set($res, 48, $value , $entrypropertiesindex);
```

## 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](#entrypropertiescount-property-ipworks_odata-class) property.

This property is not available at design time.

## Data Type

String

# EntryPropertiesValue Property ([IPWorks_OData](#odata-class) Class)

This property contains the value of the OData entry element.

## Object Oriented Interface

```text
public function getEntryPropertiesValue($entrypropertiesindex);
public function setEntryPropertiesValue($entrypropertiesindex, $value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 49 , $entrypropertiesindex);
ipworks_odata_set($res, 49, $value , $entrypropertiesindex);
```

## 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](#entrypropertiescount-property-ipworks_odata-class) property.

This property is not available at design time.

## Data Type

String

# EntryPropertiesXPath Property ([IPWorks_OData](#odata-class) Class)

This property contains the XPath of the OData entry property.

## Object Oriented Interface

```text
public function getEntryPropertiesXPath($entrypropertiesindex);
```

## Procedural Interface

```text
ipworks_odata_get($res, 50 , $entrypropertiesindex);
```

## Default Value

''

## Remarks

This property contains the XPath of the OData entry property. XPath or can be used within [UpdateProperty](#updateproperty-method-ipworks_odata-class) 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](#entrypropertiescount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# EntrySummary Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getEntrySummary();
public function setEntrySummary($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 51 );
ipworks_odata_set($res, 51, $value );
```

## Default Value

''

## Remarks

This property contains the summary of a specified entry within an OData feed. This value will be populated once [EntryIndex](#entryindex-property-ipworks_odata-class) is set (provided that a summary can be found).

This property is not applicable to OData V4 feeds.

This property is not available at design time.

## Data Type

String

# EntryTitle Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getEntryTitle();
public function setEntryTitle($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 52 );
ipworks_odata_set($res, 52, $value );
```

## Default Value

''

## Remarks

This property contains the title of a specified entry within an OData feed. This value will be populated once [EntryIndex](#entryindex-property-ipworks_odata-class) is set (provided that a title can be found).

This property is not available at design time.

## Data Type

String

# EntryType Property ([IPWorks_OData](#odata-class) Class)

This property includes the entry category or type.

## Object Oriented Interface

```text
public function getEntryType();
public function setEntryType($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 53 );
ipworks_odata_set($res, 53, $value );
```

## 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.

This property is not available at design time.

## Data Type

String

# EntryUpdated Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getEntryUpdated();
```

## Procedural Interface

```text
ipworks_odata_get($res, 54 );
```

## 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 [EntryIndex](#entryindex-property-ipworks_odata-class) 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

# EntryXML Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getEntryXML();
public function setEntryXML($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 55 );
ipworks_odata_set($res, 55, $value );
```

## Default Value

''

## Remarks

This property contains the raw XML of a specified entry within an OData feed. This value will be populated once [EntryIndex](#entryindex-property-ipworks_odata-class) is set.

This property is not available at design time.

## Data Type

String

# FirewallAutoDetect Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 56 );
ipworks_odata_set($res, 56, $value );
```

## Default Value

false

## Remarks

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

## Data Type

Boolean

# FirewallType Property ([IPWorks_OData](#odata-class) Class)

The type of firewall to connect through.

## Object Oriented Interface

```text
public function getFirewallType();
public function setFirewallType($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 57 );
ipworks_odata_set($res, 57, $value );
```

## Possible Values

```text
ODATA_FIREWALLTYPE_NONE(0), ODATA_FIREWALLTYPE_TUNNEL(1), ODATA_FIREWALLTYPE_SOCKS4(2), ODATA_FIREWALLTYPE_SOCKS5(3), ODATA_FIREWALLTYPE_SOCKS4A(10)
```

## Default Value

0

## Remarks

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

|  |  |
| --- | --- |
| fwNone (0) | No firewall (default setting). |
| fwTunnel (1) | Connect through a tunneling proxy. [FirewallPort](#firewallport-property-ipworks_odata-class) is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [FirewallPort](#firewallport-property-ipworks_odata-class) is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [FirewallPort](#firewallport-property-ipworks_odata-class) is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [FirewallPort](#firewallport-property-ipworks_odata-class) is set to 1080. |

## Data Type

Integer

# FirewallHost Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getFirewallHost();
public function setFirewallHost($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 58 );
ipworks_odata_set($res, 58, $value );
```

## Default Value

''

## Remarks

The name or IP address of the firewall (optional). If a [FirewallHost](#firewallhost-property-ipworks_odata-class) 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 class fails with an error.

## Data Type

String

# FirewallPassword Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getFirewallPassword();
public function setFirewallPassword($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 59 );
ipworks_odata_set($res, 59, $value );
```

## Default Value

''

## Remarks

A password if authentication is to be used when connecting through the firewall. If [FirewallHost](#firewallhost-property-ipworks_odata-class) is specified, the [FirewallUser](#firewalluser-property-ipworks_odata-class) and [FirewallPassword](#firewallpassword-property-ipworks_odata-class) properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

## Data Type

String

# FirewallPort Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getFirewallPort();
public function setFirewallPort($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 60 );
ipworks_odata_set($res, 60, $value );
```

## Default Value

0

## Remarks

The Transmission Control Protocol (TCP) port for the firewall [FirewallHost](#firewallhost-property-ipworks_odata-class). See the description of the [FirewallHost](#firewallhost-property-ipworks_odata-class) property for details.

NOTE: This property is set automatically when [FirewallType](#firewalltype-property-ipworks_odata-class) is set to a valid value. See the description of the [FirewallType](#firewalltype-property-ipworks_odata-class) property for details.

## Data Type

Integer

# FirewallUser Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getFirewallUser();
public function setFirewallUser($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 61 );
ipworks_odata_set($res, 61, $value );
```

## Default Value

''

## Remarks

A username if authentication is to be used when connecting through a firewall. If [FirewallHost](#firewallhost-property-ipworks_odata-class) is specified, this property and the [FirewallPassword](#firewallpassword-property-ipworks_odata-class) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the class fails with an error.

## Data Type

String

# Idle Property ([IPWorks_OData](#odata-class) Class)

The current status of the class.

## Object Oriented Interface

```text
public function getIdle();
```

## Procedural Interface

```text
ipworks_odata_get($res, 62 );
```

## 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

Boolean

# LocalHost Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getLocalHost();
public function setLocalHost($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 63 );
ipworks_odata_set($res, 63, $value );
```

## 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 class initiate connections (or accept in the case of server classes) 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 class is connected, the LocalHost 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: LocalHost is not persistent. You must always set it in code, and never in the property window.

## Data Type

String

# ODataVersion Property ([IPWorks_OData](#odata-class) Class)

This property includes the OData version.

## Object Oriented Interface

```text
public function getODataVersion();
public function setODataVersion($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 64 );
ipworks_odata_set($res, 64, $value );
```

## Possible Values

```text
ODATA_ODATAVERSION_V2(0), ODATA_ODATAVERSION_V3(1), ODATA_ODATAVERSION_V4(2), ODATA_ODATAVERSION_AUTO(3)
```

## 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 class will automatically determine the version used by the service and use the same version to format requests and parse responses. When calling [CreateEntry](#createentry-method-ipworks_odata-class) or [UpdateEntry](#updateentry-method-ipworks_odata-class), if the service version is not already known from a previous operation, the class 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](#reset-method-ipworks_odata-class) is called.

This property is not available at design time.

## Data Type

Integer

# OtherHeaders Property ([IPWorks_OData](#odata-class) Class)

Other headers as determined by the user (optional).

## Object Oriented Interface

```text
public function getOtherHeaders();
public function setOtherHeaders($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 65 );
ipworks_odata_set($res, 65, $value );
```

## 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 ContentType 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 class beyond what is provided.

This property is not available at design time.

## Data Type

String

# OtherQueryOptions Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getOtherQueryOptions();
public function setOtherQueryOptions($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 66 );
ipworks_odata_set($res, 66, $value );
```

## 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 [ServiceRootURI](#servicerooturi-property-ipworks_odata-class), [ResourcePath](#resourcepath-property-ipworks_odata-class), and any Query*** properties specified).

This property is not available at design time.

## Data Type

String

# ParsedHeaderCount Property ([IPWorks_OData](#odata-class) Class)

The number of records in the ParsedHeader arrays.

## Object Oriented Interface

```text
public function getParsedHeaderCount();
```

## Procedural Interface

```text
ipworks_odata_get($res, 67 );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [ParsedHeaderField](#parsedheaderfield-property-ipworks_odata-class)
- [ParsedHeaderValue](#parsedheadervalue-property-ipworks_odata-class)

The array indices start at *0* and end at *ParsedHeaderCount - 1*.

This property is read-only and not available at design time.

## Data Type

Integer

# ParsedHeaderField Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getParsedHeaderField($parsedheaderindex);
```

## Procedural Interface

```text
ipworks_odata_get($res, 68 , $parsedheaderindex);
```

## Default Value

''

## Remarks

This property contains the name of the HTTP [Header](#Type_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](#parsedheadercount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# ParsedHeaderValue Property ([IPWorks_OData](#odata-class) Class)

This property contains the header contents.

## Object Oriented Interface

```text
public function getParsedHeaderValue($parsedheaderindex);
```

## Procedural Interface

```text
ipworks_odata_get($res, 69 , $parsedheaderindex);
```

## Default Value

''

## Remarks

This property contains the [Header](#Type_Header) contents.

The *$parsedheaderindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ParsedHeaderCount](#parsedheadercount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# Password Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getPassword();
public function setPassword($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 70 );
ipworks_odata_set($res, 70, $value );
```

## Default Value

''

## Remarks

This property contains a password if authentication is to be used. If [AuthScheme](#authscheme-property-ipworks_odata-class) is set to HTTP Basic Authentication, the [User](#user-property-ipworks_odata-class) and Password are Base64 encoded and the result is put in the [Authorization](#Authorization) configuration setting in the form "Basic [encoded-user-password]".

If [AuthScheme](#authscheme-property-ipworks_odata-class) is set to HTTP Digest Authentication, the [User](#user-property-ipworks_odata-class) and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If [AuthScheme](#authscheme-property-ipworks_odata-class) is set to NTLM, NTLM authentication will be attempted. If [AuthScheme](#authscheme-property-ipworks_odata-class) is set to NTLM and [User](#user-property-ipworks_odata-class) and Password are empty, the class will attempt to authenticate using the current user's credentials.

## Data Type

String

# ProxyAuthScheme Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getProxyAuthScheme();
public function setProxyAuthScheme($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 71 );
ipworks_odata_set($res, 71, $value );
```

## Possible Values

```text
ODATA_PROXYAUTHSCHEME_BASIC(0), ODATA_PROXYAUTHSCHEME_DIGEST(1), ODATA_PROXYAUTHSCHEME_PROPRIETARY(2), ODATA_PROXYAUTHSCHEME_NONE(3), ODATA_PROXYAUTHSCHEME_NTLM(4), ODATA_PROXYAUTHSCHEME_NEGOTIATE(5)
```

## Default Value

0

## Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the [ProxyUser](#proxyuser-property-ipworks_odata-class) and [ProxyPassword](#proxypassword-property-ipworks_odata-class) properties are set.

[ProxyAuthScheme](#proxyauthscheme-property-ipworks_odata-class) should be set to authNone (3) when no authentication is expected.

By default, [ProxyAuthScheme](#proxyauthscheme-property-ipworks_odata-class) is authBasic (0), and if the [ProxyUser](#proxyuser-property-ipworks_odata-class) and [ProxyPassword](#proxypassword-property-ipworks_odata-class) properties are set, the class will attempt basic authentication.

If [ProxyAuthScheme](#proxyauthscheme-property-ipworks_odata-class) is set to authDigest (1), digest authentication will be attempted instead.

If [ProxyAuthScheme](#proxyauthscheme-property-ipworks_odata-class) is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If [ProxyAuthScheme](#proxyauthscheme-property-ipworks_odata-class) is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of [ProxyUser](#proxyuser-property-ipworks_odata-class) and [ProxyPassword](#proxypassword-property-ipworks_odata-class).

## Data Type

Integer

# ProxyAutoDetect Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getProxyAutoDetect();
public function setProxyAutoDetect($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 72 );
ipworks_odata_set($res, 72, $value );
```

## Default Value

false

## Remarks

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

## Data Type

Boolean

# ProxyPassword Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getProxyPassword();
public function setProxyPassword($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 73 );
ipworks_odata_set($res, 73, $value );
```

## Default Value

''

## Remarks

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

If [ProxyAuthScheme](#proxyauthscheme-property-ipworks_odata-class) is set to Basic Authentication, the [ProxyUser](#proxyuser-property-ipworks_odata-class) and [ProxyPassword](#proxypassword-property-ipworks_odata-class) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*.

If [ProxyAuthScheme](#proxyauthscheme-property-ipworks_odata-class) is set to Digest Authentication, the [ProxyUser](#proxyuser-property-ipworks_odata-class) and [ProxyPassword](#proxypassword-property-ipworks_odata-class) properties are used to respond to the Digest Authentication challenge from the server.

If [ProxyAuthScheme](#proxyauthscheme-property-ipworks_odata-class) is set to NTLM Authentication, the [ProxyUser](#proxyuser-property-ipworks_odata-class) and [ProxyPassword](#proxypassword-property-ipworks_odata-class) properties are used to authenticate through NTLM negotiation.

## Data Type

String

# ProxyPort Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getProxyPort();
public function setProxyPort($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 74 );
ipworks_odata_set($res, 74, $value );
```

## Default Value

80

## Remarks

The Transmission Control Protocol (TCP) port for the proxy [ProxyServer](#proxyserver-property-ipworks_odata-class) (default 80). See the description of the [ProxyServer](#proxyserver-property-ipworks_odata-class) property for details.

## Data Type

Integer

# ProxyServer Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getProxyServer();
public function setProxyServer($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 75 );
ipworks_odata_set($res, 75, $value );
```

## Default Value

''

## Remarks

If a proxy [ProxyServer](#proxyserver-property-ipworks_odata-class) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the [ProxyServer](#proxyserver-property-ipworks_odata-class) property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [ProxyServer](#proxyserver-property-ipworks_odata-class) property is set to the corresponding address. If the search is not successful, an error is returned.

## Data Type

String

# ProxySSL Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getProxySSL();
public function setProxySSL($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 76 );
ipworks_odata_set($res, 76, $value );
```

## Possible Values

```text
ODATA_PROXYSSL_AUTOMATIC(0), ODATA_PROXYSSL_ALWAYS(1), ODATA_PROXYSSL_NEVER(2), ODATA_PROXYSSL_TUNNEL(3)
```

## Default Value

0

## Remarks

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

|  |  |
| --- | --- |
| psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. |
| psAlways (1) | The connection is always SSL-enabled. |
| psNever (2) | The connection is not SSL-enabled. |
| psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |

## Data Type

Integer

# ProxyUser Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getProxyUser();
public function setProxyUser($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 77 );
ipworks_odata_set($res, 77, $value );
```

## Default Value

''

## Remarks

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

If [ProxyAuthScheme](#proxyauthscheme-property-ipworks_odata-class) is set to Basic Authentication, the [ProxyUser](#proxyuser-property-ipworks_odata-class) and [ProxyPassword](#proxypassword-property-ipworks_odata-class) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*.

If [ProxyAuthScheme](#proxyauthscheme-property-ipworks_odata-class) is set to Digest Authentication, the [ProxyUser](#proxyuser-property-ipworks_odata-class) and [ProxyPassword](#proxypassword-property-ipworks_odata-class) properties are used to respond to the Digest Authentication challenge from the server.

If [ProxyAuthScheme](#proxyauthscheme-property-ipworks_odata-class) is set to NTLM Authentication, the [ProxyUser](#proxyuser-property-ipworks_odata-class) and [ProxyPassword](#proxypassword-property-ipworks_odata-class) properties are used to authenticate through NTLM negotiation.

## Data Type

String

# QueryFilter Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getQueryFilter();
public function setQueryFilter($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 78 );
ipworks_odata_set($res, 78, $value );
```

## 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**

| Operator | Description | Example |
| --- | --- | --- |
| eq | Equal | "City eq 'Durham'" |
| ne | Not Equal | "City ne 'North Carolina'" |
| gt | Greater Than | "Price gt 20" |
| ge | Greater Than or Equal | "Price ge 10" |
| lt | Less Than | "Price lt 20" |
| le | Less Than or Equal | "Price le 100" |
| and | Logical And | "Price le 200 and Price gt 3.5 " |
| or | Logical Or | "Price le 3.5 or Price gt 200" |
| not | Logical Not | "not endswith(Description,'milk')" |

**Arithmetic Operators**

| Operator | Description | Example |
| --- | --- | --- |
| add | Addition | "Price add 5 gt 10" |
| sub | Subtraction | "Price sub 5 gt 10" |
| mul | Multiplication | "Price mul 2 gt 2000" |
| div | Division | "Price div 2 gt 4" |
| mod | Modulo | "Price mod 2 eq 0" |

**Grouping Operators**

| Operator | Description | Example |
| --- | --- | --- |
| ( ) | Precedence Grouping | "(Price sub 5) gt 10 " |

The following functions are supported in the expression language.

**String Functions**

| Function | Example |
| --- | --- |
| bool substringof(string po, string p1) | "substringof('Alfreds', CompanyName) eq true" |
| bool endswith(string p0, string p1) | "endswith(CompanyName, 'Futterkiste') eq true" |
| bool startswith(string p0, string p1) | "startswith(CompanyName, 'Alfr') eq true" |
| int length(string p0) | "length(CompanyName) eq 19" |
| int indexof(string p0, string p1) | "indexof(CompanyName, 'lfreds') eq 1" |
| string replace(string p0, string find, string replace) | "replace(CompanyName, ' ', '') eq 'AlfredsFutterkiste'" |
| string substring(string p0, int pos) | "substring(CompanyName, 1) eq 'lfreds Futterkiste'" |
| string substring(string p0, int pos, int length) | "substring(CompanyName, 1, 2) eq 'lf'" |
| string tolower(string p0) | "tolower(CompanyName) eq 'alfreds futterkiste'" |
| string toupper(string p0) | "toupper(CompanyName) eq 'ALFREDS FUTTERKISTE'" |
| string trim(string p0) | "trim(CompanyName) eq 'Alfreds Futterkiste'" |
| string concat(string p0, string p1) | "concat(concat(City, ', '), Country) eq 'Berlin, Germany'" |

**Date Functions**

| Function | Example |
| --- | --- |
| int day(DateTime p0) | "day(BirthDate) eq 8" |
| int hour(DateTime p0) | "hour(BirthDate) eq 0" |
| int minute(DateTime p0) | "minute(BirthDate) eq 0" |
| int month(DateTime p0) | "month(BirthDate) eq 12" |
| int second(DateTime p0) | "second(BirthDate) eq 0" |
| int year(DateTime p0) | "year(BirthDate) eq 1948" |

**Math Functions**

| Function | Example |
| --- | --- |
| double round(double p0) | "round(Freight) eq 32" |
| decimal round(decimal p0) | "round(Freight) eq 32" |
| double floor(double p0) | "round(Freight) eq 32" |
| decimal floor(decimal p0) | "floor(Freight) eq 32" |
| double ceiling(double p0) | "ceiling(Freight) eq 33" |
| decimal ceiling(decimal p0) | "floor(Freight) eq 33" |

**Type Functions**

| Function | Example |
| --- | --- |
| bool IsOf(type p0) | "isof('NorthwindModel.Order')" |
| bool IsOf(expression p0, type p1) | "isof(ShipCountry, 'Edm.String')" |

This property is not available at design time.

## Data Type

String

# QueryOrderBy Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getQueryOrderBy();
public function setQueryOrderBy($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 79 );
ipworks_odata_set($res, 79, $value );
```

## Default Value

''

## Remarks

This property allows you to specify a value by which the returned entries will be ordered after a call to [QueryService](#queryservice-method-ipworks_odata-class).

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 QueryOrderBy to *Rating desc*. If a specific order (*asc* or *desc*) is not specified, the entries will be returned in ascending order.

This property is not available at design time.

## Data Type

String

# QuerySelect Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getQuerySelect();
public function setQuerySelect($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 80 );
ipworks_odata_set($res, 80, $value );
```

## Default Value

''

## Remarks

This property allows you to specify the specific properties you want returned within an entry when calling [QueryService](#queryservice-method-ipworks_odata-class). 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 QuerySelect to *Name,Price*.

NOTE: The specified values can be a property name, navigation property name ([EntryLinksTitle](#entrylinkstitle-property-ipworks_odata-class)), or the "*" character, which returns all the properties for each entry.

This property is not available at design time.

## Data Type

String

# QuerySkip Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getQuerySkip();
public function setQuerySkip($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 81 );
ipworks_odata_set($res, 81, $value );
```

## Default Value

''

## Remarks

This property allows you to specify the number of entries to skip (from the top of the list) when calling [QueryService](#queryservice-method-ipworks_odata-class). 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 [QueryOrderBy](#queryorderby-property-ipworks_odata-class) to specify how the entries should be sorted before skipping the top N items.

This property can be used in conjunction with [QueryOrderBy](#queryorderby-property-ipworks_odata-class) and [QueryTop](#querytop-property-ipworks_odata-class) to select specific entries. For example, if you wanted to select the third and fourth highest rated item you would set [QueryOrderBy](#queryorderby-property-ipworks_odata-class) to *Rating desc* (to order the items by Rating from highest to lowest), set QuerySkip to *2* (to skip the first and second items), and finally set [QueryTop](#querytop-property-ipworks_odata-class) to *2* (to return only the third and fourth items).

This property is not available at design time.

## Data Type

String

# QuerySkipToken Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getQuerySkipToken();
public function setQuerySkipToken($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 82 );
ipworks_odata_set($res, 82, $value );
```

## 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 QuerySkipToken with the returned value. Calling [QueryService](#queryservice-method-ipworks_odata-class) again will return the next page of results.

This property is not available at design time.

## Data Type

String

# QueryTop Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getQueryTop();
public function setQueryTop($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 83 );
ipworks_odata_set($res, 83, $value );
```

## 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 [QueryService](#queryservice-method-ipworks_odata-class). 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 [QueryOrderBy](#queryorderby-property-ipworks_odata-class) to specify how the entries should be sorted before selecting the top N items.

This property is not available at design time.

## Data Type

String

# ResourcePath Property ([IPWorks_OData](#odata-class) Class)

This property includes the resource path of an OData service.

## Object Oriented Interface

```text
public function getResourcePath();
public function setResourcePath($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 84 );
ipworks_odata_set($res, 84, $value );
```

## Default Value

''

## Remarks

This property contains the resource path of an OData service and is used in conjunction with [ServiceRootURI](#servicerooturi-property-ipworks_odata-class) ([ServiceRootURI](#servicerooturi-property-ipworks_odata-class)/ResourcePath) to query feeds and modify entries.

This property will be populated when [EntryIndex](#entryindex-property-ipworks_odata-class) is set. You can change the value if you wish to send the request to a different resource path.

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

This property is not available at design time.

## Data Type

String

# SchemaAssociationContainsTarget Property ([IPWorks_OData](#odata-class) Class)

This property indicates whether the navigation property contains a target.

## Object Oriented Interface

```text
public function getSchemaAssociationContainsTarget();
```

## Procedural Interface

```text
ipworks_odata_get($res, 85 );
```

## 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

Boolean

# SchemaAssociationDescription Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaAssociationDescription();
```

## Procedural Interface

```text
ipworks_odata_get($res, 86 );
```

## 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaAssociationEntityType Property ([IPWorks_OData](#odata-class) Class)

This property contains the entity type.

## Object Oriented Interface

```text
public function getSchemaAssociationEntityType();
```

## Procedural Interface

```text
ipworks_odata_get($res, 87 );
```

## 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaAssociationFromRole Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaAssociationFromRole();
```

## Procedural Interface

```text
ipworks_odata_get($res, 88 );
```

## 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaAssociationFromRoleDescription Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaAssociationFromRoleDescription();
```

## Procedural Interface

```text
ipworks_odata_get($res, 89 );
```

## 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaAssociationFromRoleEntity Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaAssociationFromRoleEntity();
```

## Procedural Interface

```text
ipworks_odata_get($res, 90 );
```

## Default Value

''

## Remarks

This property contains the name of the entity that the [SchemaAssociationFromRole](#schemaassociationfromrole-property-ipworks_odata-class) 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaAssociationFromRoleMultiplicity Property ([IPWorks_OData](#odata-class) Class)

This property contains the multiplicity of the FromRole association endpoint.

## Object Oriented Interface

```text
public function getSchemaAssociationFromRoleMultiplicity();
```

## Procedural Interface

```text
ipworks_odata_get($res, 91 );
```

## Possible Values

```text
ODATA_SCHEMAASSOCIATIONFROMROLEMULTIPLICITY_ZERO_ONE(0), ODATA_SCHEMAASSOCIATIONFROMROLEMULTIPLICITY_ONE(1), ODATA_SCHEMAASSOCIATIONFROMROLEMULTIPLICITY_MANY(2)
```

## Default Value

0

## Remarks

This property contains the multiplicity of the [SchemaAssociationFromRole](#schemaassociationfromrole-property-ipworks_odata-class) association endpoint. This is used along with [SchemaAssociationToRoleMultiplicity](#schemaassociationtorolemultiplicity-property-ipworks_odata-class) to determine the cardinality of the relationship (i.e., one-to-one or one-to-many).

The available values are as follows:

|  |  |
| --- | --- |
| nmZeroOne (0) | Zero-One (0..1) |
| nmOne (1) | One (1) |
| nmMany (2) | Many (*) |

The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [SchemaAssociationCount](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

Integer

# SchemaAssociationFromRoleSummary Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaAssociationFromRoleSummary();
```

## Procedural Interface

```text
ipworks_odata_get($res, 92 );
```

## 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaAssociationName Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaAssociationName();
```

## Procedural Interface

```text
ipworks_odata_get($res, 93 );
```

## 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaAssociationNullable Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaAssociationNullable();
```

## Procedural Interface

```text
ipworks_odata_get($res, 94 );
```

## 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

Boolean

# SchemaAssociationOnDelete Property ([IPWorks_OData](#odata-class) Class)

This property contains the delete action to be performed.

## Object Oriented Interface

```text
public function getSchemaAssociationOnDelete();
```

## Procedural Interface

```text
ipworks_odata_get($res, 95 );
```

## Possible Values

```text
ODATA_SCHEMAASSOCIATIONONDELETE_NONE(0), ODATA_SCHEMAASSOCIATIONONDELETE_CASCADE(1), ODATA_SCHEMAASSOCIATIONONDELETE_SET_NULL(2), ODATA_SCHEMAASSOCIATIONONDELETE_SET_DEFAULT(3)
```

## Default Value

0

## Remarks

This property contains the delete action to be performed.

The possible values are as follows:

|  |  |
| --- | --- |
| 0 (daNone) | Only the specified entry instance within [SchemaAssociationFromRoleEntity](#schemaassociationfromroleentity-property-ipworks_odata-class) is deleted. This is the default value. |
| 1 (daCascade) | After the specified entry instance is deleted within [SchemaAssociationFromRoleEntity](#schemaassociationfromroleentity-property-ipworks_odata-class), the action is applied to the entry instance within the [SchemaAssociationToRoleEntity](#schemaassociationtoroleentity-property-ipworks_odata-class). For example, a single customer is associated with multiple Orders. When a customer is deleted, all orders associated with the customer also will be deleted. |
| 2 (daSetNull) | All properties of related entities that are tied to properties of the source entity through a referential constraint and that do not participate in other referential constraints will be set to null. This value is applicable only to OData Version 4. |
| 3 (daSetDefault) | All properties of related entities that are tied to properties of the source entity through a referential constraint and that do not participate in other referential constraints will be set to their default value. This value 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

Integer

# SchemaAssociationPartner Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaAssociationPartner();
```

## Procedural Interface

```text
ipworks_odata_get($res, 96 );
```

## 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaAssociationRefConstraintCount Property ([IPWorks_OData](#odata-class) Class)

This property contains the number of referential constraints.

## Object Oriented Interface

```text
public function getSchemaAssociationRefConstraintCount();
```

## Procedural Interface

```text
ipworks_odata_get($res, 97 );
```

## Default Value

0

## Remarks

This property contains the number of referential constraints. To examine the individual referential constraints set [SchemaAssociationRefConstraintIndex](#schemaassociationrefconstraintindex-property-ipworks_odata-class) to a value from 0 to [SchemaAssociationRefConstraintCount](#schemaassociationrefconstraintcount-property-ipworks_odata-class) -1. **Example. Referential Constraints:**

```text
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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

Integer

# SchemaAssociationRefConstraintIndex Property ([IPWorks_OData](#odata-class) Class)

This property contains the current index of the referential constraint.

## Object Oriented Interface

```text
public function getSchemaAssociationRefConstraintIndex();
public function setSchemaAssociationRefConstraintIndex($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 98 );
ipworks_odata_set($res, 98, $value );
```

## Default Value

0

## Remarks

This property contains the current index of the referential constraint. See [SchemaAssociationRefConstraintCount](#schemaassociationrefconstraintcount-property-ipworks_odata-class) 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is not available at design time.

## Data Type

Integer

# SchemaAssociationRefConstraintProperty Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaAssociationRefConstraintProperty();
```

## Procedural Interface

```text
ipworks_odata_get($res, 99 );
```

## 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaAssociationRefConstraintReferencedProperty Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaAssociationRefConstraintReferencedProperty();
```

## Procedural Interface

```text
ipworks_odata_get($res, 100 );
```

## 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaAssociationRelationship Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaAssociationRelationship();
```

## Procedural Interface

```text
ipworks_odata_get($res, 101 );
```

## 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaAssociationSummary Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaAssociationSummary();
```

## Procedural Interface

```text
ipworks_odata_get($res, 102 );
```

## 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaAssociationToRole Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaAssociationToRole();
```

## Procedural Interface

```text
ipworks_odata_get($res, 103 );
```

## 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaAssociationToRoleDescription Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaAssociationToRoleDescription();
```

## Procedural Interface

```text
ipworks_odata_get($res, 104 );
```

## 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaAssociationToRoleEntity Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaAssociationToRoleEntity();
```

## Procedural Interface

```text
ipworks_odata_get($res, 105 );
```

## Default Value

''

## Remarks

This property contains the name of the entity that the [SchemaAssociationToRole](#schemaassociationtorole-property-ipworks_odata-class) 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaAssociationToRoleMultiplicity Property ([IPWorks_OData](#odata-class) Class)

This property contains the multiplicity of the ToRole association endpoint.

## Object Oriented Interface

```text
public function getSchemaAssociationToRoleMultiplicity();
```

## Procedural Interface

```text
ipworks_odata_get($res, 106 );
```

## Possible Values

```text
ODATA_SCHEMAASSOCIATIONTOROLEMULTIPLICITY_ZERO_ONE(0), ODATA_SCHEMAASSOCIATIONTOROLEMULTIPLICITY_ONE(1), ODATA_SCHEMAASSOCIATIONTOROLEMULTIPLICITY_MANY(2)
```

## Default Value

0

## Remarks

This property contains the multiplicity of the [SchemaAssociationToRole](#schemaassociationtorole-property-ipworks_odata-class) association endpoint. This is used along with [SchemaAssociationFromRoleMultiplicity](#schemaassociationfromrolemultiplicity-property-ipworks_odata-class) to determine the cardinality of the relationship (i.e., one-to-one or one-to-many).

The available values are as follows:

|  |  |
| --- | --- |
| nmZeroOne (0) | Zero-One (0..1) |
| nmOne (1) | One (1) |
| nmMany (2) | Many (*) |

The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [SchemaAssociationCount](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

Integer

# SchemaAssociationToRoleSummary Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaAssociationToRoleSummary();
```

## Procedural Interface

```text
ipworks_odata_get($res, 107 );
```

## 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](#schemaassociationcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaAssociationCount Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaAssociationCount();
```

## Procedural Interface

```text
ipworks_odata_get($res, 108 );
```

## Default Value

0

## Remarks

This property is updated to reflect the total number of navigation properties within the schema entity specified by [SchemaEntityIndex](#schemaentityindex-property-ipworks_odata-class).

This property is read-only and not available at design time.

## Data Type

Integer

# SchemaAssociationIndex Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaAssociationIndex();
public function setSchemaAssociationIndex($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 109 );
ipworks_odata_set($res, 109, $value );
```

## Default Value

0

## Remarks

This property is used to specify a navigation property within an entity (specified by [SchemaEntityIndex](#schemaentityindex-property-ipworks_odata-class)). Once set, SchemaAssociation will be populated.

This property is not available at design time.

## Data Type

Integer

# SchemaEntityDescription Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaEntityDescription();
```

## Procedural Interface

```text
ipworks_odata_get($res, 110 );
```

## 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](#schemaentitycount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaEntityName Property ([IPWorks_OData](#odata-class) Class)

This property contains the name of the OData schema entity.

## Object Oriented Interface

```text
public function getSchemaEntityName();
```

## Procedural Interface

```text
ipworks_odata_get($res, 111 );
```

## 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](#schemaentitycount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaEntitySummary Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaEntitySummary();
```

## Procedural Interface

```text
ipworks_odata_get($res, 112 );
```

## 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](#schemaentitycount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaEntityCount Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaEntityCount();
```

## Procedural Interface

```text
ipworks_odata_get($res, 113 );
```

## Default Value

0

## Remarks

This property is updated to reflect the total number of entities within a schema (retrieved via [GetSchema](#getschema-method-ipworks_odata-class)).

This property is read-only and not available at design time.

## Data Type

Integer

# SchemaEntityIndex Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaEntityIndex();
public function setSchemaEntityIndex($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 114 );
ipworks_odata_set($res, 114, $value );
```

## Default Value

0

## Remarks

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

This property is not available at design time.

## Data Type

Integer

# SchemaKeysCount Property ([IPWorks_OData](#odata-class) Class)

The number of records in the SchemaKeys array.

## Object Oriented Interface

```text
public function getSchemaKeysCount();
```

## Procedural Interface

```text
ipworks_odata_get($res, 115 );
```

## Default Value

0

## Remarks

This property is read-only and not available at design time.

## Data Type

Integer

# SchemaKeys Property ([IPWorks_OData](#odata-class) Class)

This property includes the keys for a schema entity.

## Object Oriented Interface

```text
public function getSchemaKeys($schemakeysindex);
```

## Procedural Interface

```text
ipworks_odata_get($res, 116 , $schemakeysindex);
```

## 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 [SchemaEntityIndex](#schemaentityindex-property-ipworks_odata-class).

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

This property is read-only and not available at design time.

## Data Type

String

# SchemaPropertyAttributes Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaPropertyAttributes();
```

## Procedural Interface

```text
ipworks_odata_get($res, 117 );
```

## 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](#schemapropertycount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaPropertyDescription Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaPropertyDescription();
```

## Procedural Interface

```text
ipworks_odata_get($res, 118 );
```

## 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](#schemapropertycount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaPropertyIsComplexType Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaPropertyIsComplexType();
```

## Procedural Interface

```text
ipworks_odata_get($res, 119 );
```

## Default Value

false

## Remarks

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

When set to True, [SchemaTypeField](#OData_p_SchemaTypeField) 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](#schemapropertycount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

Boolean

# SchemaPropertyName Property ([IPWorks_OData](#odata-class) Class)

This property contains the Name of the OData schema property.

## Object Oriented Interface

```text
public function getSchemaPropertyName();
```

## Procedural Interface

```text
ipworks_odata_get($res, 120 );
```

## 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](#schemapropertycount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaPropertyNullable Property ([IPWorks_OData](#odata-class) Class)

This property indicates whether a property can be null.

## Object Oriented Interface

```text
public function getSchemaPropertyNullable();
```

## Procedural Interface

```text
ipworks_odata_get($res, 121 );
```

## 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](#schemapropertycount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

Boolean

# SchemaPropertySchemaType Property ([IPWorks_OData](#odata-class) Class)

This property contains the type of the OData schema property.

## Object Oriented Interface

```text
public function getSchemaPropertySchemaType();
```

## Procedural Interface

```text
ipworks_odata_get($res, 122 );
```

## 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](#schemapropertycount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaPropertySummary Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaPropertySummary();
```

## Procedural Interface

```text
ipworks_odata_get($res, 123 );
```

## 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](#schemapropertycount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaPropertyCount Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaPropertyCount();
```

## Procedural Interface

```text
ipworks_odata_get($res, 124 );
```

## Default Value

0

## Remarks

This property is updated to reflect the total number of properties within the schema entity specified by [SchemaEntityIndex](#schemaentityindex-property-ipworks_odata-class).

This property is read-only and not available at design time.

## Data Type

Integer

# SchemaPropertyIndex Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaPropertyIndex();
public function setSchemaPropertyIndex($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 125 );
ipworks_odata_set($res, 125, $value );
```

## Default Value

0

## Remarks

This property is used to specify a property within an entity (specified by [SchemaEntityIndex](#schemaentityindex-property-ipworks_odata-class)). Once set, SchemaProperty will be populated.

This property is not available at design time.

## Data Type

Integer

# SchemaTypeFieldAttributes Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaTypeFieldAttributes();
```

## Procedural Interface

```text
ipworks_odata_get($res, 126 );
```

## 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](#schematypefieldcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaTypeFieldDescription Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaTypeFieldDescription();
```

## Procedural Interface

```text
ipworks_odata_get($res, 127 );
```

## 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](#schematypefieldcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaTypeFieldIsComplexType Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaTypeFieldIsComplexType();
```

## Procedural Interface

```text
ipworks_odata_get($res, 128 );
```

## Default Value

false

## Remarks

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

When set to True, [SchemaTypeField](#OData_p_SchemaTypeField) 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](#schematypefieldcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

Boolean

# SchemaTypeFieldName Property ([IPWorks_OData](#odata-class) Class)

This property contains the Name of the OData schema property.

## Object Oriented Interface

```text
public function getSchemaTypeFieldName();
```

## Procedural Interface

```text
ipworks_odata_get($res, 129 );
```

## 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](#schematypefieldcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaTypeFieldNullable Property ([IPWorks_OData](#odata-class) Class)

This property indicates whether a property can be null.

## Object Oriented Interface

```text
public function getSchemaTypeFieldNullable();
```

## Procedural Interface

```text
ipworks_odata_get($res, 130 );
```

## 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](#schematypefieldcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

Boolean

# SchemaTypeFieldSchemaType Property ([IPWorks_OData](#odata-class) Class)

This property contains the type of the OData schema property.

## Object Oriented Interface

```text
public function getSchemaTypeFieldSchemaType();
```

## Procedural Interface

```text
ipworks_odata_get($res, 131 );
```

## 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](#schematypefieldcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaTypeFieldSummary Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaTypeFieldSummary();
```

## Procedural Interface

```text
ipworks_odata_get($res, 132 );
```

## 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](#schematypefieldcount-property-ipworks_odata-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SchemaTypeFieldCount Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaTypeFieldCount();
```

## Procedural Interface

```text
ipworks_odata_get($res, 133 );
```

## 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 [SchemaPropertyIndex](#schemapropertyindex-property-ipworks_odata-class) or by explicitly setting the type via [SetSchemaType](#setschematype-method-ipworks_odata-class).

This property is read-only and not available at design time.

## Data Type

Integer

# SchemaTypeFieldIndex Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSchemaTypeFieldIndex();
public function setSchemaTypeFieldIndex($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 134 );
ipworks_odata_set($res, 134, $value );
```

## Default Value

0

## Remarks

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

This property is not available at design time.

## Data Type

Integer

# ServiceRootURI Property ([IPWorks_OData](#odata-class) Class)

This property includes the root URI of an OData service.

## Object Oriented Interface

```text
public function getServiceRootURI();
public function setServiceRootURI($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 135 );
ipworks_odata_set($res, 135, $value );
```

## Default Value

''

## Remarks

This property contains the root URI of an OData service. This value is used in conjunction with [ResourcePath](#resourcepath-property-ipworks_odata-class) (ServiceRootURI/[ResourcePath](#resourcepath-property-ipworks_odata-class)) to query feeds and modify entries.

**Example.**

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

This property is not available at design time.

## Data Type

String

# SSLAcceptServerCertEffectiveDate Property ([IPWorks_OData](#odata-class) Class)

The date on which this certificate becomes valid.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertEffectiveDate();
```

## Procedural Interface

```text
ipworks_odata_get($res, 136 );
```

## 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

# SSLAcceptServerCertExpirationDate Property ([IPWorks_OData](#odata-class) Class)

The date on which the certificate expires.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertExpirationDate();
```

## Procedural Interface

```text
ipworks_odata_get($res, 137 );
```

## 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

# SSLAcceptServerCertExtendedKeyUsage Property ([IPWorks_OData](#odata-class) Class)

A comma-delimited list of extended key usage identifiers.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertExtendedKeyUsage();
```

## Procedural Interface

```text
ipworks_odata_get($res, 138 );
```

## 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

# SSLAcceptServerCertFingerprint Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertFingerprint();
```

## Procedural Interface

```text
ipworks_odata_get($res, 139 );
```

## 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

# SSLAcceptServerCertFingerprintSHA1 Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertFingerprintSHA1();
```

## Procedural Interface

```text
ipworks_odata_get($res, 140 );
```

## 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

# SSLAcceptServerCertFingerprintSHA256 Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertFingerprintSHA256();
```

## Procedural Interface

```text
ipworks_odata_get($res, 141 );
```

## 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

# SSLAcceptServerCertIssuer Property ([IPWorks_OData](#odata-class) Class)

The issuer of the certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertIssuer();
```

## Procedural Interface

```text
ipworks_odata_get($res, 142 );
```

## 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

# SSLAcceptServerCertPrivateKey Property ([IPWorks_OData](#odata-class) Class)

The private key of the certificate (if available).

## Object Oriented Interface

```text
public function getSSLAcceptServerCertPrivateKey();
```

## Procedural Interface

```text
ipworks_odata_get($res, 143 );
```

## Default Value

''

## Remarks

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

NOTE: The [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-ipworks_odata-class) may be available but not exportable. In this case, [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-ipworks_odata-class) returns an empty string.

This property is read-only.

## Data Type

String

# SSLAcceptServerCertPrivateKeyAvailable Property ([IPWorks_OData](#odata-class) Class)

Whether a PrivateKey is available for the selected certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertPrivateKeyAvailable();
```

## Procedural Interface

```text
ipworks_odata_get($res, 144 );
```

## Default Value

false

## Remarks

Whether a [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-ipworks_odata-class) is available for the selected certificate. If [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-ipworks_odata-class) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

Boolean

# SSLAcceptServerCertPrivateKeyContainer Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertPrivateKeyContainer();
```

## Procedural Interface

```text
ipworks_odata_get($res, 145 );
```

## Default Value

''

## Remarks

The name of the [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-ipworks_odata-class) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# SSLAcceptServerCertPublicKey Property ([IPWorks_OData](#odata-class) Class)

The public key of the certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertPublicKey();
```

## Procedural Interface

```text
ipworks_odata_get($res, 146 );
```

## 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

# SSLAcceptServerCertPublicKeyAlgorithm Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertPublicKeyAlgorithm();
```

## Procedural Interface

```text
ipworks_odata_get($res, 147 );
```

## 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

# SSLAcceptServerCertPublicKeyLength Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertPublicKeyLength();
```

## Procedural Interface

```text
ipworks_odata_get($res, 148 );
```

## 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

Integer

# SSLAcceptServerCertSerialNumber Property ([IPWorks_OData](#odata-class) Class)

The serial number of the certificate encoded as a string.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertSerialNumber();
```

## Procedural Interface

```text
ipworks_odata_get($res, 149 );
```

## 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

# SSLAcceptServerCertSignatureAlgorithm Property ([IPWorks_OData](#odata-class) Class)

The text description of the certificate's signature algorithm.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertSignatureAlgorithm();
```

## Procedural Interface

```text
ipworks_odata_get($res, 150 );
```

## 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

# SSLAcceptServerCertStore Property ([IPWorks_OData](#odata-class) Class)

The name of the certificate store for the client certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 151 );
ipworks_odata_set($res, 151, $value );
```

## Default Value

'MY'

## Remarks

The name of the certificate store for the client certificate.

The [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-ipworks_odata-class) property denotes the type of the certificate store specified by [SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworks_odata-class). If the store is password-protected, specify the password in [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-ipworks_odata-class).

[SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworks_odata-class) is used in conjunction with the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworks_odata-class) property to specify client certificates. If [SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworks_odata-class) has a value, and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworks_odata-class) or [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-ipworks_odata-class) is set, a search for a certificate is initiated. Please see the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworks_odata-class) property for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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

Binary String

# SSLAcceptServerCertStorePassword Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 152 );
ipworks_odata_set($res, 152, $value );
```

## 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

# SSLAcceptServerCertStoreType Property ([IPWorks_OData](#odata-class) Class)

The type of certificate store for this certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 153 );
ipworks_odata_set($res, 153, $value );
```

## Possible Values

```text
ODATA_SSLACCEPTSERVERCERTSTORETYPE_USER(0), ODATA_SSLACCEPTSERVERCERTSTORETYPE_MACHINE(1), ODATA_SSLACCEPTSERVERCERTSTORETYPE_PFXFILE(2), ODATA_SSLACCEPTSERVERCERTSTORETYPE_PFXBLOB(3), ODATA_SSLACCEPTSERVERCERTSTORETYPE_JKSFILE(4), ODATA_SSLACCEPTSERVERCERTSTORETYPE_JKSBLOB(5), ODATA_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_FILE(6), ODATA_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_BLOB(7), ODATA_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), ODATA_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), ODATA_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), ODATA_SSLACCEPTSERVERCERTSTORETYPE_P7BFILE(11), ODATA_SSLACCEPTSERVERCERTSTORETYPE_P7BBLOB(12), ODATA_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), ODATA_SSLACCEPTSERVERCERTSTORETYPE_PPKFILE(14), ODATA_SSLACCEPTSERVERCERTSTORETYPE_PPKBLOB(15), ODATA_SSLACCEPTSERVERCERTSTORETYPE_XMLFILE(16), ODATA_SSLACCEPTSERVERCERTSTORETYPE_XMLBLOB(17), ODATA_SSLACCEPTSERVERCERTSTORETYPE_JWKFILE(18), ODATA_SSLACCEPTSERVERCERTSTORETYPE_JWKBLOB(19), ODATA_SSLACCEPTSERVERCERTSTORETYPE_SECURITY_KEY(20), ODATA_SSLACCEPTSERVERCERTSTORETYPE_BCFKSFILE(21), ODATA_SSLACCEPTSERVERCERTSTORETYPE_BCFKSBLOB(22), ODATA_SSLACCEPTSERVERCERTSTORETYPE_PKCS11(23), ODATA_SSLACCEPTSERVERCERTSTORETYPE_AUTO(99)
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-ipworks_odata-class), the full path of the PKCS#11 DLL as the [SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworks_odata-class), and the PIN as the [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-ipworks_odata-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworks_odata-class) and set [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-ipworks_odata-class) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

## Data Type

Integer

# SSLAcceptServerCertSubjectAltNames Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertSubjectAltNames();
```

## Procedural Interface

```text
ipworks_odata_get($res, 154 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# SSLAcceptServerCertThumbprintMD5 Property ([IPWorks_OData](#odata-class) Class)

The MD5 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertThumbprintMD5();
```

## Procedural Interface

```text
ipworks_odata_get($res, 155 );
```

## 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

# SSLAcceptServerCertThumbprintSHA1 Property ([IPWorks_OData](#odata-class) Class)

The SHA-1 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertThumbprintSHA1();
```

## Procedural Interface

```text
ipworks_odata_get($res, 156 );
```

## 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

# SSLAcceptServerCertThumbprintSHA256 Property ([IPWorks_OData](#odata-class) Class)

The SHA-256 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertThumbprintSHA256();
```

## Procedural Interface

```text
ipworks_odata_get($res, 157 );
```

## 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

# SSLAcceptServerCertUsage Property ([IPWorks_OData](#odata-class) Class)

The text description of UsageFlags .

## Object Oriented Interface

```text
public function getSSLAcceptServerCertUsage();
```

## Procedural Interface

```text
ipworks_odata_get($res, 158 );
```

## Default Value

''

## Remarks

The text description of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-ipworks_odata-class).

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

# SSLAcceptServerCertUsageFlags Property ([IPWorks_OData](#odata-class) Class)

The flags that show intended use for the certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertUsageFlags();
```

## Procedural Interface

```text
ipworks_odata_get($res, 159 );
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-ipworks_odata-class) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [SSLAcceptServerCertUsage](#sslacceptservercertusage-property-ipworks_odata-class) property for a text representation of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-ipworks_odata-class).

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

This property is read-only.

## Data Type

Integer

# SSLAcceptServerCertVersion Property ([IPWorks_OData](#odata-class) Class)

The certificate's version number.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertVersion();
```

## Procedural Interface

```text
ipworks_odata_get($res, 160 );
```

## 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

# SSLAcceptServerCertSubject Property ([IPWorks_OData](#odata-class) Class)

The subject of the certificate used for client authentication.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 161 );
ipworks_odata_set($res, 161, $value );
```

## 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:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

## Data Type

String

# SSLAcceptServerCertEncoded Property ([IPWorks_OData](#odata-class) Class)

The certificate (PEM/Base64 encoded).

## Object Oriented Interface

```text
public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 162 );
ipworks_odata_set($res, 162, $value );
```

## Default Value

''

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworks_odata-class) and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworks_odata-class) properties also may be used to specify a certificate.

When [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-ipworks_odata-class) is set, a search is initiated in the current [SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworks_odata-class) for the private key of the certificate. If the key is found, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworks_odata-class) is updated to reflect the full subject of the selected certificate; otherwise, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworks_odata-class) is set to an empty string.

This property is not available at design time.

## Data Type

Binary String

# SSLCertEffectiveDate Property ([IPWorks_OData](#odata-class) Class)

The date on which this certificate becomes valid.

## Object Oriented Interface

```text
public function getSSLCertEffectiveDate();
```

## Procedural Interface

```text
ipworks_odata_get($res, 163 );
```

## 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

# SSLCertExpirationDate Property ([IPWorks_OData](#odata-class) Class)

The date on which the certificate expires.

## Object Oriented Interface

```text
public function getSSLCertExpirationDate();
```

## Procedural Interface

```text
ipworks_odata_get($res, 164 );
```

## 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

# SSLCertExtendedKeyUsage Property ([IPWorks_OData](#odata-class) Class)

A comma-delimited list of extended key usage identifiers.

## Object Oriented Interface

```text
public function getSSLCertExtendedKeyUsage();
```

## Procedural Interface

```text
ipworks_odata_get($res, 165 );
```

## 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

# SSLCertFingerprint Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertFingerprint();
```

## Procedural Interface

```text
ipworks_odata_get($res, 166 );
```

## 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

# SSLCertFingerprintSHA1 Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertFingerprintSHA1();
```

## Procedural Interface

```text
ipworks_odata_get($res, 167 );
```

## 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

# SSLCertFingerprintSHA256 Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertFingerprintSHA256();
```

## Procedural Interface

```text
ipworks_odata_get($res, 168 );
```

## 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

# SSLCertIssuer Property ([IPWorks_OData](#odata-class) Class)

The issuer of the certificate.

## Object Oriented Interface

```text
public function getSSLCertIssuer();
```

## Procedural Interface

```text
ipworks_odata_get($res, 169 );
```

## 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

# SSLCertPrivateKey Property ([IPWorks_OData](#odata-class) Class)

The private key of the certificate (if available).

## Object Oriented Interface

```text
public function getSSLCertPrivateKey();
```

## Procedural Interface

```text
ipworks_odata_get($res, 170 );
```

## Default Value

''

## Remarks

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

NOTE: The [SSLCertPrivateKey](#sslcertprivatekey-property-ipworks_odata-class) may be available but not exportable. In this case, [SSLCertPrivateKey](#sslcertprivatekey-property-ipworks_odata-class) returns an empty string.

This property is read-only.

## Data Type

String

# SSLCertPrivateKeyAvailable Property ([IPWorks_OData](#odata-class) Class)

Whether a PrivateKey is available for the selected certificate.

## Object Oriented Interface

```text
public function getSSLCertPrivateKeyAvailable();
```

## Procedural Interface

```text
ipworks_odata_get($res, 171 );
```

## Default Value

false

## Remarks

Whether a [SSLCertPrivateKey](#sslcertprivatekey-property-ipworks_odata-class) is available for the selected certificate. If [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-ipworks_odata-class) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

Boolean

# SSLCertPrivateKeyContainer Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertPrivateKeyContainer();
```

## Procedural Interface

```text
ipworks_odata_get($res, 172 );
```

## Default Value

''

## Remarks

The name of the [SSLCertPrivateKey](#sslcertprivatekey-property-ipworks_odata-class) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# SSLCertPublicKey Property ([IPWorks_OData](#odata-class) Class)

The public key of the certificate.

## Object Oriented Interface

```text
public function getSSLCertPublicKey();
```

## Procedural Interface

```text
ipworks_odata_get($res, 173 );
```

## 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

# SSLCertPublicKeyAlgorithm Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertPublicKeyAlgorithm();
```

## Procedural Interface

```text
ipworks_odata_get($res, 174 );
```

## 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

# SSLCertPublicKeyLength Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertPublicKeyLength();
```

## Procedural Interface

```text
ipworks_odata_get($res, 175 );
```

## 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

Integer

# SSLCertSerialNumber Property ([IPWorks_OData](#odata-class) Class)

The serial number of the certificate encoded as a string.

## Object Oriented Interface

```text
public function getSSLCertSerialNumber();
```

## Procedural Interface

```text
ipworks_odata_get($res, 176 );
```

## 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

# SSLCertSignatureAlgorithm Property ([IPWorks_OData](#odata-class) Class)

The text description of the certificate's signature algorithm.

## Object Oriented Interface

```text
public function getSSLCertSignatureAlgorithm();
```

## Procedural Interface

```text
ipworks_odata_get($res, 177 );
```

## 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

# SSLCertStore Property ([IPWorks_OData](#odata-class) Class)

The name of the certificate store for the client certificate.

## Object Oriented Interface

```text
public function getSSLCertStore();
public function setSSLCertStore($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 178 );
ipworks_odata_set($res, 178, $value );
```

## Default Value

'MY'

## Remarks

The name of the certificate store for the client certificate.

The [SSLCertStoreType](#sslcertstoretype-property-ipworks_odata-class) property denotes the type of the certificate store specified by [SSLCertStore](#sslcertstore-property-ipworks_odata-class). If the store is password-protected, specify the password in [SSLCertStorePassword](#sslcertstorepassword-property-ipworks_odata-class).

[SSLCertStore](#sslcertstore-property-ipworks_odata-class) is used in conjunction with the [SSLCertSubject](#sslcertsubject-property-ipworks_odata-class) property to specify client certificates. If [SSLCertStore](#sslcertstore-property-ipworks_odata-class) has a value, and [SSLCertSubject](#sslcertsubject-property-ipworks_odata-class) or [SSLCertEncoded](#sslcertencoded-property-ipworks_odata-class) is set, a search for a certificate is initiated. Please see the [SSLCertSubject](#sslcertsubject-property-ipworks_odata-class) property for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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

Binary String

# SSLCertStorePassword Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 179 );
ipworks_odata_set($res, 179, $value );
```

## 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

# SSLCertStoreType Property ([IPWorks_OData](#odata-class) Class)

The type of certificate store for this certificate.

## Object Oriented Interface

```text
public function getSSLCertStoreType();
public function setSSLCertStoreType($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 180 );
ipworks_odata_set($res, 180, $value );
```

## Possible Values

```text
ODATA_SSLCERTSTORETYPE_USER(0), ODATA_SSLCERTSTORETYPE_MACHINE(1), ODATA_SSLCERTSTORETYPE_PFXFILE(2), ODATA_SSLCERTSTORETYPE_PFXBLOB(3), ODATA_SSLCERTSTORETYPE_JKSFILE(4), ODATA_SSLCERTSTORETYPE_JKSBLOB(5), ODATA_SSLCERTSTORETYPE_PEMKEY_FILE(6), ODATA_SSLCERTSTORETYPE_PEMKEY_BLOB(7), ODATA_SSLCERTSTORETYPE_PUBLIC_KEY_FILE(8), ODATA_SSLCERTSTORETYPE_PUBLIC_KEY_BLOB(9), ODATA_SSLCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), ODATA_SSLCERTSTORETYPE_P7BFILE(11), ODATA_SSLCERTSTORETYPE_P7BBLOB(12), ODATA_SSLCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), ODATA_SSLCERTSTORETYPE_PPKFILE(14), ODATA_SSLCERTSTORETYPE_PPKBLOB(15), ODATA_SSLCERTSTORETYPE_XMLFILE(16), ODATA_SSLCERTSTORETYPE_XMLBLOB(17), ODATA_SSLCERTSTORETYPE_JWKFILE(18), ODATA_SSLCERTSTORETYPE_JWKBLOB(19), ODATA_SSLCERTSTORETYPE_SECURITY_KEY(20), ODATA_SSLCERTSTORETYPE_BCFKSFILE(21), ODATA_SSLCERTSTORETYPE_BCFKSBLOB(22), ODATA_SSLCERTSTORETYPE_PKCS11(23), ODATA_SSLCERTSTORETYPE_AUTO(99)
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLCertStoreType](#sslcertstoretype-property-ipworks_odata-class), the full path of the PKCS#11 DLL as the [SSLCertStore](#sslcertstore-property-ipworks_odata-class), and the PIN as the [SSLCertStorePassword](#sslcertstorepassword-property-ipworks_odata-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLCertStore](#sslcertstore-property-ipworks_odata-class) and set [SSLCertStorePassword](#sslcertstorepassword-property-ipworks_odata-class) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

## Data Type

Integer

# SSLCertSubjectAltNames Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertSubjectAltNames();
```

## Procedural Interface

```text
ipworks_odata_get($res, 181 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# SSLCertThumbprintMD5 Property ([IPWorks_OData](#odata-class) Class)

The MD5 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLCertThumbprintMD5();
```

## Procedural Interface

```text
ipworks_odata_get($res, 182 );
```

## 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

# SSLCertThumbprintSHA1 Property ([IPWorks_OData](#odata-class) Class)

The SHA-1 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLCertThumbprintSHA1();
```

## Procedural Interface

```text
ipworks_odata_get($res, 183 );
```

## 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

# SSLCertThumbprintSHA256 Property ([IPWorks_OData](#odata-class) Class)

The SHA-256 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLCertThumbprintSHA256();
```

## Procedural Interface

```text
ipworks_odata_get($res, 184 );
```

## 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

# SSLCertUsage Property ([IPWorks_OData](#odata-class) Class)

The text description of UsageFlags .

## Object Oriented Interface

```text
public function getSSLCertUsage();
```

## Procedural Interface

```text
ipworks_odata_get($res, 185 );
```

## Default Value

''

## Remarks

The text description of [SSLCertUsageFlags](#sslcertusageflags-property-ipworks_odata-class).

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

# SSLCertUsageFlags Property ([IPWorks_OData](#odata-class) Class)

The flags that show intended use for the certificate.

## Object Oriented Interface

```text
public function getSSLCertUsageFlags();
```

## Procedural Interface

```text
ipworks_odata_get($res, 186 );
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [SSLCertUsageFlags](#sslcertusageflags-property-ipworks_odata-class) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [SSLCertUsage](#sslcertusage-property-ipworks_odata-class) property for a text representation of [SSLCertUsageFlags](#sslcertusageflags-property-ipworks_odata-class).

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

This property is read-only.

## Data Type

Integer

# SSLCertVersion Property ([IPWorks_OData](#odata-class) Class)

The certificate's version number.

## Object Oriented Interface

```text
public function getSSLCertVersion();
```

## Procedural Interface

```text
ipworks_odata_get($res, 187 );
```

## 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

# SSLCertSubject Property ([IPWorks_OData](#odata-class) Class)

The subject of the certificate used for client authentication.

## Object Oriented Interface

```text
public function getSSLCertSubject();
public function setSSLCertSubject($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 188 );
ipworks_odata_set($res, 188, $value );
```

## 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:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

## Data Type

String

# SSLCertEncoded Property ([IPWorks_OData](#odata-class) Class)

The certificate (PEM/Base64 encoded).

## Object Oriented Interface

```text
public function getSSLCertEncoded();
public function setSSLCertEncoded($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 189 );
ipworks_odata_set($res, 189, $value );
```

## Default Value

''

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLCertStore](#sslcertstore-property-ipworks_odata-class) and [SSLCertSubject](#sslcertsubject-property-ipworks_odata-class) properties also may be used to specify a certificate.

When [SSLCertEncoded](#sslcertencoded-property-ipworks_odata-class) is set, a search is initiated in the current [SSLCertStore](#sslcertstore-property-ipworks_odata-class) for the private key of the certificate. If the key is found, [SSLCertSubject](#sslcertsubject-property-ipworks_odata-class) is updated to reflect the full subject of the selected certificate; otherwise, [SSLCertSubject](#sslcertsubject-property-ipworks_odata-class) is set to an empty string.

This property is not available at design time.

## Data Type

Binary String

# SSLProvider Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLProvider();
public function setSSLProvider($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 190 );
ipworks_odata_set($res, 190, $value );
```

## Possible Values

```text
ODATA_SSLPROVIDER_AUTOMATIC(0), ODATA_SSLPROVIDER_PLATFORM(1), ODATA_SSLPROVIDER_INTERNAL(2)
```

## 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 class 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:

|  |  |
| --- | --- |
| 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
| 1 (sslpPlatform) | Uses the platform/system implementation. |
| 2 (sslpInternal) | Uses the internal implementation. |

 **Additional Notes**

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

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the class 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

Integer

# SSLServerCertEffectiveDate Property ([IPWorks_OData](#odata-class) Class)

The date on which this certificate becomes valid.

## Object Oriented Interface

```text
public function getSSLServerCertEffectiveDate();
```

## Procedural Interface

```text
ipworks_odata_get($res, 191 );
```

## 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

# SSLServerCertExpirationDate Property ([IPWorks_OData](#odata-class) Class)

The date on which the certificate expires.

## Object Oriented Interface

```text
public function getSSLServerCertExpirationDate();
```

## Procedural Interface

```text
ipworks_odata_get($res, 192 );
```

## 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

# SSLServerCertExtendedKeyUsage Property ([IPWorks_OData](#odata-class) Class)

A comma-delimited list of extended key usage identifiers.

## Object Oriented Interface

```text
public function getSSLServerCertExtendedKeyUsage();
```

## Procedural Interface

```text
ipworks_odata_get($res, 193 );
```

## 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

# SSLServerCertFingerprint Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertFingerprint();
```

## Procedural Interface

```text
ipworks_odata_get($res, 194 );
```

## 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

# SSLServerCertFingerprintSHA1 Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertFingerprintSHA1();
```

## Procedural Interface

```text
ipworks_odata_get($res, 195 );
```

## 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

# SSLServerCertFingerprintSHA256 Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertFingerprintSHA256();
```

## Procedural Interface

```text
ipworks_odata_get($res, 196 );
```

## 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

# SSLServerCertIssuer Property ([IPWorks_OData](#odata-class) Class)

The issuer of the certificate.

## Object Oriented Interface

```text
public function getSSLServerCertIssuer();
```

## Procedural Interface

```text
ipworks_odata_get($res, 197 );
```

## 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

# SSLServerCertPrivateKey Property ([IPWorks_OData](#odata-class) Class)

The private key of the certificate (if available).

## Object Oriented Interface

```text
public function getSSLServerCertPrivateKey();
```

## Procedural Interface

```text
ipworks_odata_get($res, 198 );
```

## Default Value

''

## Remarks

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

NOTE: The [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ipworks_odata-class) may be available but not exportable. In this case, [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ipworks_odata-class) returns an empty string.

This property is read-only.

## Data Type

String

# SSLServerCertPrivateKeyAvailable Property ([IPWorks_OData](#odata-class) Class)

Whether a PrivateKey is available for the selected certificate.

## Object Oriented Interface

```text
public function getSSLServerCertPrivateKeyAvailable();
```

## Procedural Interface

```text
ipworks_odata_get($res, 199 );
```

## Default Value

false

## Remarks

Whether a [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ipworks_odata-class) is available for the selected certificate. If [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-ipworks_odata-class) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

Boolean

# SSLServerCertPrivateKeyContainer Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertPrivateKeyContainer();
```

## Procedural Interface

```text
ipworks_odata_get($res, 200 );
```

## Default Value

''

## Remarks

The name of the [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ipworks_odata-class) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# SSLServerCertPublicKey Property ([IPWorks_OData](#odata-class) Class)

The public key of the certificate.

## Object Oriented Interface

```text
public function getSSLServerCertPublicKey();
```

## Procedural Interface

```text
ipworks_odata_get($res, 201 );
```

## 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

# SSLServerCertPublicKeyAlgorithm Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertPublicKeyAlgorithm();
```

## Procedural Interface

```text
ipworks_odata_get($res, 202 );
```

## 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

# SSLServerCertPublicKeyLength Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertPublicKeyLength();
```

## Procedural Interface

```text
ipworks_odata_get($res, 203 );
```

## 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

Integer

# SSLServerCertSerialNumber Property ([IPWorks_OData](#odata-class) Class)

The serial number of the certificate encoded as a string.

## Object Oriented Interface

```text
public function getSSLServerCertSerialNumber();
```

## Procedural Interface

```text
ipworks_odata_get($res, 204 );
```

## 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

# SSLServerCertSignatureAlgorithm Property ([IPWorks_OData](#odata-class) Class)

The text description of the certificate's signature algorithm.

## Object Oriented Interface

```text
public function getSSLServerCertSignatureAlgorithm();
```

## Procedural Interface

```text
ipworks_odata_get($res, 205 );
```

## 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

# SSLServerCertStore Property ([IPWorks_OData](#odata-class) Class)

The name of the certificate store for the client certificate.

## Object Oriented Interface

```text
public function getSSLServerCertStore();
```

## Procedural Interface

```text
ipworks_odata_get($res, 206 );
```

## Default Value

'MY'

## Remarks

The name of the certificate store for the client certificate.

The [SSLServerCertStoreType](#sslservercertstoretype-property-ipworks_odata-class) property denotes the type of the certificate store specified by [SSLServerCertStore](#sslservercertstore-property-ipworks_odata-class). If the store is password-protected, specify the password in [SSLServerCertStorePassword](#sslservercertstorepassword-property-ipworks_odata-class).

[SSLServerCertStore](#sslservercertstore-property-ipworks_odata-class) is used in conjunction with the [SSLServerCertSubject](#sslservercertsubject-property-ipworks_odata-class) property to specify client certificates. If [SSLServerCertStore](#sslservercertstore-property-ipworks_odata-class) has a value, and [SSLServerCertSubject](#sslservercertsubject-property-ipworks_odata-class) or [SSLServerCertEncoded](#sslservercertencoded-property-ipworks_odata-class) is set, a search for a certificate is initiated. Please see the [SSLServerCertSubject](#sslservercertsubject-property-ipworks_odata-class) property for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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

Binary String

# SSLServerCertStorePassword Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertStorePassword();
```

## Procedural Interface

```text
ipworks_odata_get($res, 207 );
```

## 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

# SSLServerCertStoreType Property ([IPWorks_OData](#odata-class) Class)

The type of certificate store for this certificate.

## Object Oriented Interface

```text
public function getSSLServerCertStoreType();
```

## Procedural Interface

```text
ipworks_odata_get($res, 208 );
```

## Possible Values

```text
ODATA_SSLSERVERCERTSTORETYPE_USER(0), ODATA_SSLSERVERCERTSTORETYPE_MACHINE(1), ODATA_SSLSERVERCERTSTORETYPE_PFXFILE(2), ODATA_SSLSERVERCERTSTORETYPE_PFXBLOB(3), ODATA_SSLSERVERCERTSTORETYPE_JKSFILE(4), ODATA_SSLSERVERCERTSTORETYPE_JKSBLOB(5), ODATA_SSLSERVERCERTSTORETYPE_PEMKEY_FILE(6), ODATA_SSLSERVERCERTSTORETYPE_PEMKEY_BLOB(7), ODATA_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), ODATA_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), ODATA_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), ODATA_SSLSERVERCERTSTORETYPE_P7BFILE(11), ODATA_SSLSERVERCERTSTORETYPE_P7BBLOB(12), ODATA_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), ODATA_SSLSERVERCERTSTORETYPE_PPKFILE(14), ODATA_SSLSERVERCERTSTORETYPE_PPKBLOB(15), ODATA_SSLSERVERCERTSTORETYPE_XMLFILE(16), ODATA_SSLSERVERCERTSTORETYPE_XMLBLOB(17), ODATA_SSLSERVERCERTSTORETYPE_JWKFILE(18), ODATA_SSLSERVERCERTSTORETYPE_JWKBLOB(19), ODATA_SSLSERVERCERTSTORETYPE_SECURITY_KEY(20), ODATA_SSLSERVERCERTSTORETYPE_BCFKSFILE(21), ODATA_SSLSERVERCERTSTORETYPE_BCFKSBLOB(22), ODATA_SSLSERVERCERTSTORETYPE_PKCS11(23), ODATA_SSLSERVERCERTSTORETYPE_AUTO(99)
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLServerCertStoreType](#sslservercertstoretype-property-ipworks_odata-class), the full path of the PKCS#11 DLL as the [SSLServerCertStore](#sslservercertstore-property-ipworks_odata-class), and the PIN as the [SSLServerCertStorePassword](#sslservercertstorepassword-property-ipworks_odata-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLServerCertStore](#sslservercertstore-property-ipworks_odata-class) and set [SSLServerCertStorePassword](#sslservercertstorepassword-property-ipworks_odata-class) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

This property is read-only.

## Data Type

Integer

# SSLServerCertSubjectAltNames Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertSubjectAltNames();
```

## Procedural Interface

```text
ipworks_odata_get($res, 209 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# SSLServerCertThumbprintMD5 Property ([IPWorks_OData](#odata-class) Class)

The MD5 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLServerCertThumbprintMD5();
```

## Procedural Interface

```text
ipworks_odata_get($res, 210 );
```

## 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

# SSLServerCertThumbprintSHA1 Property ([IPWorks_OData](#odata-class) Class)

The SHA-1 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLServerCertThumbprintSHA1();
```

## Procedural Interface

```text
ipworks_odata_get($res, 211 );
```

## 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

# SSLServerCertThumbprintSHA256 Property ([IPWorks_OData](#odata-class) Class)

The SHA-256 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLServerCertThumbprintSHA256();
```

## Procedural Interface

```text
ipworks_odata_get($res, 212 );
```

## 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

# SSLServerCertUsage Property ([IPWorks_OData](#odata-class) Class)

The text description of UsageFlags .

## Object Oriented Interface

```text
public function getSSLServerCertUsage();
```

## Procedural Interface

```text
ipworks_odata_get($res, 213 );
```

## Default Value

''

## Remarks

The text description of [SSLServerCertUsageFlags](#sslservercertusageflags-property-ipworks_odata-class).

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

# SSLServerCertUsageFlags Property ([IPWorks_OData](#odata-class) Class)

The flags that show intended use for the certificate.

## Object Oriented Interface

```text
public function getSSLServerCertUsageFlags();
```

## Procedural Interface

```text
ipworks_odata_get($res, 214 );
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [SSLServerCertUsageFlags](#sslservercertusageflags-property-ipworks_odata-class) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [SSLServerCertUsage](#sslservercertusage-property-ipworks_odata-class) property for a text representation of [SSLServerCertUsageFlags](#sslservercertusageflags-property-ipworks_odata-class).

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

This property is read-only.

## Data Type

Integer

# SSLServerCertVersion Property ([IPWorks_OData](#odata-class) Class)

The certificate's version number.

## Object Oriented Interface

```text
public function getSSLServerCertVersion();
```

## Procedural Interface

```text
ipworks_odata_get($res, 215 );
```

## 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

# SSLServerCertSubject Property ([IPWorks_OData](#odata-class) Class)

The subject of the certificate used for client authentication.

## Object Oriented Interface

```text
public function getSSLServerCertSubject();
```

## Procedural Interface

```text
ipworks_odata_get($res, 216 );
```

## 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:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

This property is read-only.

## Data Type

String

# SSLServerCertEncoded Property ([IPWorks_OData](#odata-class) Class)

The certificate (PEM/Base64 encoded).

## Object Oriented Interface

```text
public function getSSLServerCertEncoded();
```

## Procedural Interface

```text
ipworks_odata_get($res, 217 );
```

## Default Value

''

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLServerCertStore](#sslservercertstore-property-ipworks_odata-class) and [SSLServerCertSubject](#sslservercertsubject-property-ipworks_odata-class) properties also may be used to specify a certificate.

When [SSLServerCertEncoded](#sslservercertencoded-property-ipworks_odata-class) is set, a search is initiated in the current [SSLServerCertStore](#sslservercertstore-property-ipworks_odata-class) for the private key of the certificate. If the key is found, [SSLServerCertSubject](#sslservercertsubject-property-ipworks_odata-class) is updated to reflect the full subject of the selected certificate; otherwise, [SSLServerCertSubject](#sslservercertsubject-property-ipworks_odata-class) is set to an empty string.

This property is read-only and not available at design time.

## Data Type

Binary String

# Timeout Property ([IPWorks_OData](#odata-class) Class)

The timeout for the class.

## Object Oriented Interface

```text
public function getTimeout();
public function setTimeout($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 218 );
ipworks_odata_set($res, 218, $value );
```

## 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 class will wait for the operation to complete before returning control.

The class will use DoEvents 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 class 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

Integer

# TransferredData Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getTransferredData();
```

## Procedural Interface

```text
ipworks_odata_get($res, 219 );
```

## Default Value

''

## Remarks

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

TransferredData will be populated after a successful [QueryService](#queryservice-method-ipworks_odata-class) or [CustomRequest](#customrequest-method-ipworks_odata-class) call, provided that LocalFile is not set. If LocalFile is set, the object data will be written to the file specified.

This property is read-only and not available at design time.

## Data Type

Binary String

# User Property ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function getUser();
public function setUser($value);
```

## Procedural Interface

```text
ipworks_odata_get($res, 220 );
ipworks_odata_set($res, 220, $value );
```

## Default Value

''

## Remarks

This property contains a user name if authentication is to be used. If [AuthScheme](#authscheme-property-ipworks_odata-class) is set to HTTP Basic Authentication, The User and [Password](#password-property-ipworks_odata-class) are Base64 encoded, and the result is put in the [Authorization](#Authorization) property in the form "Basic [encoded-user-password]".

If [AuthScheme](#authscheme-property-ipworks_odata-class) is set to HTTP Digest Authentication, the User and [Password](#password-property-ipworks_odata-class) properties are used to respond to the HTTP Digest Authentication challenge from the server.

If [AuthScheme](#authscheme-property-ipworks_odata-class) is set to NTLM, NTLM authentication will be attempted. If [AuthScheme](#authscheme-property-ipworks_odata-class) is set to NTLM, and User and [Password](#password-property-ipworks_odata-class) are empty, the class will attempt to authenticate using the current user's credentials.

## Data Type

String

# Config Method ([IPWorks_OData](#odata-class) Class)

Sets or retrieves a configuration setting.

## Object Oriented Interface

```text
public function doConfig($configurationstring);
```

## Procedural Interface

```text
ipworks_odata_do_config($res, $configurationstring);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-odata-class) for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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](#config-settings-odata-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

# CreateEntry Method ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function doCreateEntry();
```

## Procedural Interface

```text
ipworks_odata_do_createentry($res);
```

## Remarks

The component will use the items contained within EntryProperties to create a new entry within the feed service resource by [ServiceRootURI](#servicerooturi-property-ipworks_odata-class) and [ResourcePath](#resourcepath-property-ipworks_odata-class) ([ServiceRootURI](#servicerooturi-property-ipworks_odata-class)/[ResourcePath](#resourcepath-property-ipworks_odata-class)).

Upon a successful creation, all previous entries contained by the component, before the CreateEntry call, will be cleared and replaced with the response entry data. [EntryIndex](#entryindex-property-ipworks_odata-class) will then be set to 0 (the first entry within the response), populating the [EntryAuthor](#entryauthor-property-ipworks_odata-class), [EntryETag](#entryetag-property-ipworks_odata-class), [EntryTitle](#entrytitle-property-ipworks_odata-class), [EntrySummary](#entrysummary-property-ipworks_odata-class), [EntryUpdated](#entryupdated-property-ipworks_odata-class), EntryLinks, and EntryProperties properties. [OtherHeaders](#otherheaders-property-ipworks_odata-class) will also be cleared and thus will need to be reset accordingly with each call made.

# CustomRequest Method ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function doCustomRequest($httpmethod, $url, $postdata);
```

## Procedural Interface

```text
ipworks_odata_do_customrequest($res, $httpmethod, $url, $postdata);
```

## Remarks

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

NOTE: All values specified are taken as entered.

[OtherHeaders](#otherheaders-property-ipworks_odata-class) 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 [TransferredData](#transferreddata-property-ipworks_odata-class) property, as well as through the [Transfer](#transfer-event-ipworks_odata-class) event. The response headers can be retrieved through the TransferredHeaders property as well as through the [Header](#header-event-ipworks_odata-class) event.

The class will then attempt to parse the search results. Upon successfully parsing the response, Channel will be set with their associated feed element values and [EntryCount](#entrycount-property-ipworks_odata-class) will be populated with the total number of entries contained within the feed. [EntryIndex](#entryindex-property-ipworks_odata-class) also will be set to 1, thus populating EntryProperties.

# DeleteEntry Method ([IPWorks_OData](#odata-class) Class)

This method deletes an entry within an OData service resource.

## Object Oriented Interface

```text
public function doDeleteEntry();
```

## Procedural Interface

```text
ipworks_odata_do_deleteentry($res);
```

## Remarks

The component will delete the entry, of an OData service resource, specified by [ServiceRootURI](#servicerooturi-property-ipworks_odata-class) and [ResourcePath](#resourcepath-property-ipworks_odata-class) ([ServiceRootURI](#servicerooturi-property-ipworks_odata-class)/[ResourcePath](#resourcepath-property-ipworks_odata-class)).

An "If-Match" header will be sent in the delete request with the value contained within [EntryETag](#entryetag-property-ipworks_odata-class).

Upon a successful entry deletion, all previous entries contained by the component, before the DeleteEntry call, will be cleared. [OtherHeaders](#otherheaders-property-ipworks_odata-class) also will be cleared and thus will need to be reset accordingly with each call made.

# GetEntryProperty Method ([IPWorks_OData](#odata-class) Class)

This method gets an OData entry property.

## Object Oriented Interface

```text
public function doGetEntryProperty($xpath);
```

## Procedural Interface

```text
ipworks_odata_do_getentryproperty($res, $xpath);
```

## Remarks

This method is intended to extend the functionality of the OData class 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 [EntryIndex](#entryindex-property-ipworks_odata-class) 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 [EntryIndex](#entryindex-property-ipworks_odata-class).

**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 GetEntryProperty method will return the text portion of **property**.

**Example 1. Attribute Not Supplied:**

```text
	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:

```text
	ODataControl.EntryIndex = 1
	ODataControl.GetEntryProperty("ID")
	ODataControl.GetEntryProperty("ID@type")
	ODataControl.GetEntryProperty("Address/State")
```

# GetSchema Method ([IPWorks_OData](#odata-class) Class)

This method retrieves the schema for a service.

## Object Oriented Interface

```text
public function doGetSchema();
```

## Procedural Interface

```text
ipworks_odata_do_getschema($res);
```

## Remarks

This method will retrieve the schema (metadata document) of the service specified by [ServiceRootURI](#servicerooturi-property-ipworks_odata-class).

Upon successful retrieval of the schema, set [SchemaEntityIndex](#schemaentityindex-property-ipworks_odata-class) 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.

# HasXPath Method ([IPWorks_OData](#odata-class) Class)

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

## Object Oriented Interface

```text
public function doHasXPath($xpath);
```

## Procedural Interface

```text
ipworks_odata_do_hasxpath($res, $xpath);
```

## 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.

# QueryService Method ([IPWorks_OData](#odata-class) Class)

This method queries an OData service using the specified parameters.

## Object Oriented Interface

```text
public function doQueryService();
```

## Procedural Interface

```text
ipworks_odata_do_queryservice($res);
```

## Remarks

This method queries an OData feed specified by [ServiceRootURI](#servicerooturi-property-ipworks_odata-class) and [ResourcePath](#resourcepath-property-ipworks_odata-class) ([ServiceRootURI](#servicerooturi-property-ipworks_odata-class)/[ResourcePath](#resourcepath-property-ipworks_odata-class)) using the query options specified in the Query*** properties and [OtherQueryOptions](#otherqueryoptions-property-ipworks_odata-class). To retrieve an OData feed, without performing any filtering, you can leave Query*** and [OtherQueryOptions](#otherqueryoptions-property-ipworks_odata-class) empty and call QueryService.

The query results are delivered in the [TransferredData](#transferreddata-property-ipworks_odata-class) property, as well as through the [Transfer](#transfer-event-ipworks_odata-class) event. The response headers can be retrieved through the ParsedHeaders property as well as through the [Header](#header-event-ipworks_odata-class) event.

The class will attempt to parse the query results. Upon successfully parsing the response, Channel will be set with their associated feed element values and [EntryCount](#entrycount-property-ipworks_odata-class) will be populated with the total number of entries contained within the feed. [EntryIndex](#entryindex-property-ipworks_odata-class) will also be set to 1, thus populating [EntryAuthor](#entryauthor-property-ipworks_odata-class), [EntryETag](#entryetag-property-ipworks_odata-class), [EntryTitle](#entrytitle-property-ipworks_odata-class), [EntrySummary](#entrysummary-property-ipworks_odata-class), [EntryUpdated](#entryupdated-property-ipworks_odata-class), EntryLinks, EntryProperties, and [ResourcePath](#resourcepath-property-ipworks_odata-class).

# Reset Method ([IPWorks_OData](#odata-class) Class)

This method resets all of properties of the class.

## Object Oriented Interface

```text
public function doReset();
```

## Procedural Interface

```text
ipworks_odata_do_reset($res);
```

## Remarks

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

# SetEntryProperty Method ([IPWorks_OData](#odata-class) Class)

This method is used to set an OData entry property.

## Object Oriented Interface

```text
public function doSetEntryProperty($xpath, $value);
```

## Procedural Interface

```text
ipworks_odata_do_setentryproperty($res, $xpath, $value);
```

## Remarks

This method is intended to extend functionality of the OData class 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 EntryProperties.

*XPath* is the XPath of the element or attribute according to the following convention: **entry[x]/element**. When [EntryIndex](#entryindex-property-ipworks_odata-class) 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 class will use the specified [EntryIndex](#entryindex-property-ipworks_odata-class) 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:**

```text
	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:

```text
	ODataControl.EntryIndex = 1
	ODataControl.SetEntryProperty("Name", "MyNewName")
	ODataControl.SetEntryProperty("Address/State", "NC")
```

# SetSchemaEntity Method ([IPWorks_OData](#odata-class) Class)

This method sets the schema entity.

## Object Oriented Interface

```text
public function doSetSchemaEntity($name);
```

## Procedural Interface

```text
ipworks_odata_do_setschemaentity($res, $name);
```

## Remarks

The class will set the schema entity to the *Name* specified. Once set, you can view the keys (via [SchemaKeys](#schemakeys-property-ipworks_odata-class)), properties (via SchemaProperty), and navigation properties (via SchemaAssociation) contained within the specified entity.

# SetSchemaProperty Method ([IPWorks_OData](#odata-class) Class)

This method sets the schema property.

## Object Oriented Interface

```text
public function doSetSchemaProperty($name);
```

## Procedural Interface

```text
ipworks_odata_do_setschemaproperty($res, $name);
```

## Remarks

The class will set the schema property to the *Name* specified. Once set, you can view the details of the property (via SchemaProperty) along with the complex type details (via SchemaTypeField); provided that the property is derived from the complex type.

# SetSchemaType Method ([IPWorks_OData](#odata-class) Class)

This method sets the schema type.

## Object Oriented Interface

```text
public function doSetSchemaType($name);
```

## Procedural Interface

```text
ipworks_odata_do_setschematype($res, $name);
```

## Remarks

The class will set the schema type to the *Name* specified. Once set, you can view the details of the complex type (via SchemaTypeField).

# UpdateEntry Method ([IPWorks_OData](#odata-class) Class)

This method updates an OData entry.

## Object Oriented Interface

```text
public function doUpdateEntry();
```

## Procedural Interface

```text
ipworks_odata_do_updateentry($res);
```

## Remarks

The class will update the OData entry specified by [ServiceRootURI](#servicerooturi-property-ipworks_odata-class) and [ResourcePath](#resourcepath-property-ipworks_odata-class) ([ServiceRootURI](#servicerooturi-property-ipworks_odata-class)/[ResourcePath](#resourcepath-property-ipworks_odata-class)). It also will update the OData entry with the elements specified by EntryProperties.

Upon a successful update, all previous entries contained by the component, before the UpdateEntry call, will be cleared and replaced with the response entry data. [EntryIndex](#entryindex-property-ipworks_odata-class) will then be set to zero (the first entry within the response), populating the [EntryAuthor](#entryauthor-property-ipworks_odata-class), [EntryETag](#entryetag-property-ipworks_odata-class), [EntryTitle](#entrytitle-property-ipworks_odata-class), [EntrySummary](#entrysummary-property-ipworks_odata-class), [EntryUpdated](#entryupdated-property-ipworks_odata-class), EntryLinks, EntryProperties, and [ResourcePath](#resourcepath-property-ipworks_odata-class) properties. [OtherHeaders](#otherheaders-property-ipworks_odata-class) will also be cleared and thus will need to be reset accordingly with each call made.

# UpdateProperty Method ([IPWorks_OData](#odata-class) Class)

This method updates an OData entry property.

## Object Oriented Interface

```text
public function doUpdateProperty($xpath, $value);
```

## Procedural Interface

```text
ipworks_odata_do_updateproperty($res, $xpath, $value);
```

## Remarks

The class will update the OData entry specified by [ServiceRootURI](#servicerooturi-property-ipworks_odata-class) and [ResourcePath](#resourcepath-property-ipworks_odata-class) ([ServiceRootURI](#servicerooturi-property-ipworks_odata-class)/[ResourcePath](#resourcepath-property-ipworks_odata-class)). 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 UpdateProperty call, will be cleared and replaced with the response entry data. [EntryIndex](#entryindex-property-ipworks_odata-class) will then be set to zero (the first entry within the response), populating the [EntryAuthor](#entryauthor-property-ipworks_odata-class), [EntryETag](#entryetag-property-ipworks_odata-class), [EntryTitle](#entrytitle-property-ipworks_odata-class), [EntrySummary](#entrysummary-property-ipworks_odata-class), [EntryUpdated](#entryupdated-property-ipworks_odata-class), EntryLinks, EntryProperties, and [ResourcePath](#resourcepath-property-ipworks_odata-class). [OtherHeaders](#otherheaders-property-ipworks_odata-class) will also be cleared and thus will need to be reset accordingly with each call made.

# Connected Event ([IPWorks_OData](#odata-class) Class)

Fired immediately after a connection completes (or fails).

## Object Oriented Interface

```text
public function fireConnected($param);
```

## Procedural Interface

```text
ipworks_odata_register_callback($res, 1, array($this, 'fireConnected'));
```

## Parameter List

```text
 'statuscode' 'description'
```

## Remarks

If the connection is made normally, *StatusCode* is 0 and *Description* is "OK".

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

Please refer to the [Error Codes](#trappable-errors-odata-class) section for more information.

# Disconnected Event ([IPWorks_OData](#odata-class) Class)

Fired when a connection is closed.

## Object Oriented Interface

```text
public function fireDisconnected($param);
```

## Procedural Interface

```text
ipworks_odata_register_callback($res, 2, array($this, 'fireDisconnected'));
```

## Parameter List

```text
 'statuscode' 'description'
```

## Remarks

If the connection is broken normally, *StatusCode* is 0 and *Description* is "OK".

If the connection is broken for any other reason, *StatusCode* has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the TCP/IP error.

Please refer to the [Error Codes](#trappable-errors-odata-class) section for more information.

# EndTransfer Event ([IPWorks_OData](#odata-class) Class)

This event fires when a document finishes transferring.

## Object Oriented Interface

```text
public function fireEndTransfer($param);
```

## Procedural Interface

```text
ipworks_odata_register_callback($res, 3, array($this, 'fireEndTransfer'));
```

## Parameter List

```text
 'direction'
```

## Remarks

The EndTransfer 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.

# Entity Event ([IPWorks_OData](#odata-class) Class)

This event is fired once for each entity retrieved.

## Object Oriented Interface

```text
public function fireEntity($param);
```

## Procedural Interface

```text
ipworks_odata_register_callback($res, 4, array($this, 'fireEntity'));
```

## Parameter List

```text
 'name'
```

## Remarks

The Entity event is fired once for each entity found when retrieving a service's schema (metadata document) through [GetSchema](#getschema-method-ipworks_odata-class).

# Entry Event ([IPWorks_OData](#odata-class) Class)

This event is fired once for each entry retrieved.

## Object Oriented Interface

```text
public function fireEntry($param);
```

## Procedural Interface

```text
ipworks_odata_register_callback($res, 5, array($this, 'fireEntry'));
```

## Parameter List

```text
 'id' 'title' 'summary' 'etag'
```

## Remarks

The Entry event is fired once for each entry found in the response.

The entry properties are provided through EntryProperties.

The entry links are provided through EntryLinks.

# Error Event ([IPWorks_OData](#odata-class) Class)

Fired when information is available about errors during data delivery.

## Object Oriented Interface

```text
public function fireError($param);
```

## Procedural Interface

```text
ipworks_odata_register_callback($res, 6, array($this, 'fireError'));
```

## Parameter List

```text
 'errorcode' 'description'
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The *ErrorCode* 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](#trappable-errors-odata-class) section.

# Header Event ([IPWorks_OData](#odata-class) Class)

Fired every time a header line comes in.

## Object Oriented Interface

```text
public function fireHeader($param);
```

## Procedural Interface

```text
ipworks_odata_register_callback($res, 7, array($this, 'fireHeader'));
```

## Parameter List

```text
 'field' 'value'
```

## 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).

# Log Event ([IPWorks_OData](#odata-class) Class)

Fired once for each log message.

## Object Oriented Interface

```text
public function fireLog($param);
```

## Procedural Interface

```text
ipworks_odata_register_callback($res, 8, array($this, 'fireLog'));
```

## Parameter List

```text
 'loglevel' 'message' 'logtype'
```

## Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting.

*LogLevel* indicates the level of message. Possible values are as follows:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

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.

*LogType* identifies the type of log entry. Possible values are as follows:

- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"

# Property Event ([IPWorks_OData](#odata-class) Class)

This event is fired once for each property found within an entity.

## Object Oriented Interface

```text
public function fireProperty($param);
```

## Procedural Interface

```text
ipworks_odata_register_callback($res, 9, array($this, 'fireProperty'));
```

## Parameter List

```text
 'name' 'typename' 'nullable'
```

## Remarks

The Property event is fired once for each property found within an entity after setting [SchemaEntityIndex](#schemaentityindex-property-ipworks_odata-class).

# SetCookie Event ([IPWorks_OData](#odata-class) Class)

Fired for every cookie set by the server.

## Object Oriented Interface

```text
public function fireSetCookie($param);
```

## Procedural Interface

```text
ipworks_odata_register_callback($res, 10, array($this, 'fireSetCookie'));
```

## Parameter List

```text
 'name' 'value' 'expires' 'domain' 'path' 'secure'
```

## 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 (URLServer) 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 (URLPath) 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.

# SSLServerAuthentication Event ([IPWorks_OData](#odata-class) Class)

Fired after the server presents its certificate to the client.

## Object Oriented Interface

```text
public function fireSSLServerAuthentication($param);
```

## Procedural Interface

```text
ipworks_odata_register_callback($res, 11, array($this, 'fireSSLServerAuthentication'));
```

## Parameter List

```text
 'certencoded' 'certsubject' 'certissuer' 'status' 'accept'
```

## 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.

# SSLStatus Event ([IPWorks_OData](#odata-class) Class)

Fired when secure connection progress messages are available.

## Object Oriented Interface

```text
public function fireSSLStatus($param);
```

## Procedural Interface

```text
ipworks_odata_register_callback($res, 12, array($this, 'fireSSLStatus'));
```

## Parameter List

```text
 'message'
```

## Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

# StartTransfer Event ([IPWorks_OData](#odata-class) Class)

This event fires when a document starts transferring (after the headers).

## Object Oriented Interface

```text
public function fireStartTransfer($param);
```

## Procedural Interface

```text
ipworks_odata_register_callback($res, 13, array($this, 'fireStartTransfer'));
```

## Parameter List

```text
 'direction'
```

## Remarks

The StartTransfer 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.

# Status Event ([IPWorks_OData](#odata-class) Class)

Fired when the HTTP status line is received from the server.

## Object Oriented Interface

```text
public function fireStatus($param);
```

## Procedural Interface

```text
ipworks_odata_register_callback($res, 14, array($this, 'fireStatus'));
```

## Parameter List

```text
 'httpversion' 'statuscode' 'description'
```

## Remarks

*HTTPVersion* is a string containing the HTTP version string as returned from the server (e.g., "1.1").

*StatusCode* contains the HTTP status code (e.g., 200), and *Description* the associated message returned by the server (e.g., "OK").

# Transfer Event ([IPWorks_OData](#odata-class) Class)

Fired while a document transfers (delivers document).

## Object Oriented Interface

```text
public function fireTransfer($param);
```

## Procedural Interface

```text
ipworks_odata_register_callback($res, 15, array($this, 'fireTransfer'));
```

## Parameter List

```text
 'direction' 'bytestransferred' 'percentdone' 'text'
```

## 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 *BytesTransferred* 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](#odata-class) Class)

 The class 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 class, access to these *internal properties* is provided through the [Config](#config-method-ipworks_odata-class) method.

### OData Config Settings

**EncodeResourcePath**: Whether the ResourcePath is URL encoded.This configuration setting specifies whether [ResourcePath](#resourcepath-property-ipworks_odata-class) is URL encoded in the request. By default, this is True and the value is URL encoded. This may be set to False to prevent encoding.

**NameAndEmailFormat**: Determines how the data of the name and e-mail properties will be formatted.This configuration setting allows you to control how the data of the name and e-mail properties will be formatted. The available formats are as follows:

|  |  |
| --- | --- |
| 0 (default) | SMTP Format: Name <e-mail address> |
| 1 | Name only. |
| 2 | E-mail address only. |

**TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server.

### HTTP Config Settings

**AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the class adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The class only supports gzip and deflate decompression algorithms.

**AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

**AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.

The default value is True.

**Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

**Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server.

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

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

**BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [Transfer](#transfer-event-ipworks_odata-class) event, by [BytesTransferred](#BytesTransferred).

**ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

**CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

**EncodeURL**: If set to True the URL will be encoded by the class.If set to True, the URL passed to the class will be URL encoded. The default value is False.

**FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.

**Note:** Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for *GET* or *HEAD* requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, [User](#user-property-ipworks_odata-class) and [Password](#password-property-ipworks_odata-class) are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.

Following are the valid options:

- 0 - Never
- 1 - Always
- 2 - Same Scheme

**GetOn302Redirect**: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again.

**HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

**HTTPVersion**: The version of HTTP used by the class.This property specifies the HTTP version used by the class. Possible values are as follows:

- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"

When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details.

**HTTP/2 Notes**

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed.

**HTTP/3 Notes**

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

**IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:

```text
Sat, 29 Oct 2017 19:43:31 GMT.
```

**KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *true*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *false*, the connection will be closed immediately after the server response is received.

 The default value for [KeepAlive](#KeepAlive) is *false*.

**KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

**LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [Log](#log-event-ipworks_odata-class) event. Possible values are as follows:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

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).

**MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

**NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

**OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

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 configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the class beyond what is provided.

**ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If [ProxyUser](#proxyuser-property-ipworks_odata-class) and [ProxyPassword](#proxypassword-property-ipworks_odata-class) are specified, this value is calculated using the algorithm specified by [ProxyAuthScheme](#proxyauthscheme-property-ipworks_odata-class).

**ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client.

**StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server.

**StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*.

**TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server.

**TransferredDataLimit**: The maximum number of incoming bytes to be stored by the class.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

**TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server.

**TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

 .NET

```text
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
```

 C++

```text
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
```

**UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

**UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*. In the C++ Edition for Windows, the *W version of the class must be used. For instance, *DNSW* or *HTTPW*.

**UsePlatformHTTPClient**: Whether or not to use the platform HTTP client.When using this configuration setting, if True, the component will use the default HTTP client for the platform (*URLConnection* in Java, *WebRequest* in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

NOTE: This setting is applicable only to Mac/iOS editions.

**UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and [ProxyAutoDetect](#proxyautodetect-property-ipworks_odata-class) is set to *True*.

When *True* (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

**UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

### TCPClient Config Settings

**ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use [Timeout](#timeout-property-ipworks_odata-class) for establishing a connection and transmitting/receiving data.

**FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting.

If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting.

**FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value.

NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallType**: Determines the type of firewall to connect through.Possible values are as follows:

|  |  |
| --- | --- |
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. |

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

NOTE: This value is not applicable in macOS.

**KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

**Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

**LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

**LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-ipworks_odata-class) setting 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 value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface.

If the class is connected, the [LocalHost](#localhost-property-ipworks_odata-class) setting 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).

**LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

**MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset.

If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset.

The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes.

**MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

**ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

*www.google.com;www.example.com*

**TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets.

NOTE: This value is not applicable in Java.

**TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

**UseIPv6**: Whether to use IPv6.When set to *0* (default), the class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows:

|  |  |
| --- | --- |
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |

**UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1.

### SSL Config Settings

**LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-ipworks_odata-class) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-ipworks_odata-class) event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-ipworks_odata-class) is set to *Platform*.

**OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

 -----BEGIN CERTIFICATE-----

 ... (CA certificate in base64 encoding) ...

 -----END CERTIFICATE-----

 Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

**OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

**ReuseSSLSession**: Determines if the SSL session is reused.

If set to True, the class will reuse the context if and only if the following criteria are met:

- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.

**SSLCACertFilePaths**: The paths to CA certificate files on Unix/Linux.This configuration setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

*/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem*

**SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-ipworks_odata-class) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----
```

**SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.

When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the class fails with an error.

When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-ipworks_odata-class) event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting.

**SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----
```

**SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when [SSLProvider](#sslprovider-property-ipworks_odata-class) is set to *Platform* include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
```

 Possible values when [SSLProvider](#sslprovider-property-ipworks_odata-class) is set to *Platform* include the following:

- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF

 Example values when [SSLProvider](#sslprovider-property-ipworks_odata-class) is set to *Internal*include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
```

 Possible values when [SSLProvider](#sslprovider-property-ipworks_odata-class) is set to *Internal* include the following:

- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported:

- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256

[SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength).

**SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values:

|  |  |
| --- | --- |
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
| TLS1.1 | 768 (Hex 300) (Default - Client) |
| TLS1 | 192 (Hex C0) (Default - Client) |
| SSL3 | 48 (Hex 30) |
| SSL2 | 12 (Hex 0C) |

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

**SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:**

By default when TLS 1.3 is enabled, the class will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-ipworks_odata-class) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-ipworks_odata-class) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to *1* (Platform provider), please be aware of the following notes:

- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported.
- If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

**SSLEnabledProtocols: SSL2 and SSL3 Notes: **

SSL 2.0 and 3.0 are not supported by the class when the [SSLProvider](#sslprovider-property-ipworks_odata-class) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-ipworks_odata-class) needs to be set to platform.

**SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension.

This configuration setting is applicable only when [SSLProvider](#sslprovider-property-ipworks_odata-class) is set to *Internal*.

**SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-ipworks_odata-class) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-ipworks_odata-class) event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-ipworks_odata-class) event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

**SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.

NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-ipworks_odata-class) is set to *Internal*.

**SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipher[connId]");
```

**SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherStrength[connId]");
```

**SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherSuite[connId]");
```

**SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchange[connId]");
```

**SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
```

**SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedVersion[connId]");
```

**SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:

|  |  |
| --- | --- |
| 0x00000001 | Ignore time validity status of certificate. |
| 0x00000002 | Ignore time validity status of CTL. |
| 0x00000004 | Ignore non-nested certificate times. |
| 0x00000010 | Allow unknown certificate authority. |
| 0x00000020 | Ignore wrong certificate usage. |
| 0x00000100 | Ignore unknown certificate revocation status. |
| 0x00000200 | Ignore unknown CTL signer revocation status. |
| 0x00000400 | Ignore unknown certificate authority revocation status. |
| 0x00000800 | Ignore unknown root revocation status. |
| 0x00008000 | Allow test root certificate. |
| 0x00004000 | Trust test root certificate. |
| 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |

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

**SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----
```

**TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-ipworks_odata-class) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.

The format of this value is a comma-separated list of hash-signature combinations. For instance:

```csharp
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
```

 The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

**TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*.

When using TLS 1.2 and [SSLProvider](#sslprovider-property-ipworks_odata-class) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported:

- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)

**TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"

**TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)

 The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3.

**TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
- "mlkem_512" (default)
- "mlkem_768" (default)
- "mlkem_1024" (default)
- "x25519_mlkem_768" (default)
- "secp256r1_mlkem_768" (default)

Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported:

-  Windows Server 2025
-  Windows 11 24H2
-  Windows 11 25H2

### Socket Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-ipworks_odata-class) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

**FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

**InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

**OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

**SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([OData](#odata-class) Class)

### OData Errors

|  |  |
| --- | --- |
| 601 | The feed URL is required. |

The class may also return one of the following error codes, which are inherited from other classes.

### HTTP Errors

|  |  |
| --- | --- |
| 118 | Firewall error. The error description contains the detailed message. |
| 143 | Busy executing current method. |
| 151 | HTTP protocol error. The error message has the server response. |
| 152 | No server specified in URL. |
| 153 | Specified URLScheme is invalid. |
| 155 | Range operation is not supported by server. |
| 156 | Invalid cookie index (out of range). |
| 301 | Interrupted. |
| 302 | Cannot open AttachedFile. |

The class may also return one of the following error codes, which are inherited from other classes.

### TCPClient Errors

|  |  |
| --- | --- |
| 100 | You cannot change the RemotePort at this time. A connection is in progress. |
| 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
| 102 | The RemoteHost address is invalid (0.0.0.0). |
| 104 | Already connected. If you want to reconnect, close the current connection first. |
| 106 | You cannot change the LocalPort at this time. A connection is in progress. |
| 107 | You cannot change the [LocalHost](#localhost-property-ipworks_odata-class) at this time. A connection is in progress. |
| 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. |
| 116 | RemotePort cannot be zero. Please specify a valid service port number. |
| 117 | You cannot change the UseConnection option while the class is active. |
| 135 | Operation would block. |
| 201 | Timeout. |
| 211 | Action impossible in control's present state. |
| 212 | Action impossible while not connected. |
| 213 | Action impossible while listening. |
| 301 | Timeout. |
| 302 | Could not open file. |
| 434 | Unable to convert string to selected CodePage. |
| 1105 | Already connecting. If you want to reconnect, close the current connection first. |
| 1117 | You need to connect first. |
| 1119 | You cannot change the LocalHost at this time. A connection is in progress. |
| 1120 | Connection dropped by remote host. |

### SSL Errors

|  |  |
| --- | --- |
| 270 | Cannot load specified security library. |
| 271 | Cannot open certificate store. |
| 272 | Cannot find specified certificate. |
| 273 | Cannot acquire security credentials. |
| 274 | Cannot find certificate chain. |
| 275 | Cannot verify certificate chain. |
| 276 | Error during handshake. |
| 280 | Error verifying certificate. |
| 281 | Could not find client certificate. |
| 282 | Could not find server certificate. |
| 283 | Error encrypting data. |
| 284 | Error decrypting data. |

### TCP/IP Errors

|  |  |
| --- | --- |
| 10004 | [10004] Interrupted system call. |
| 10009 | [10009] Bad file number. |
| 10013 | [10013] Access denied. |
| 10014 | [10014] Bad address. |
| 10022 | [10022] Invalid argument. |
| 10024 | [10024] Too many open files. |
| 10035 | [10035] Operation would block. |
| 10036 | [10036] Operation now in progress. |
| 10037 | [10037] Operation already in progress. |
| 10038 | [10038] Socket operation on nonsocket. |
| 10039 | [10039] Destination address required. |
| 10040 | [10040] Message is too long. |
| 10041 | [10041] Protocol wrong type for socket. |
| 10042 | [10042] Bad protocol option. |
| 10043 | [10043] Protocol is not supported. |
| 10044 | [10044] Socket type is not supported. |
| 10045 | [10045] Operation is not supported on socket. |
| 10046 | [10046] Protocol family is not supported. |
| 10047 | [10047] Address family is not supported by protocol family. |
| 10048 | [10048] Address already in use. |
| 10049 | [10049] Cannot assign requested address. |
| 10050 | [10050] Network is down. |
| 10051 | [10051] Network is unreachable. |
| 10052 | [10052] Net dropped connection or reset. |
| 10053 | [10053] Software caused connection abort. |
| 10054 | [10054] Connection reset by peer. |
| 10055 | [10055] No buffer space available. |
| 10056 | [10056] Socket is already connected. |
| 10057 | [10057] Socket is not connected. |
| 10058 | [10058] Cannot send after socket shutdown. |
| 10059 | [10059] Too many references, cannot splice. |
| 10060 | [10060] Connection timed out. |
| 10061 | [10061] Connection refused. |
| 10062 | [10062] Too many levels of symbolic links. |
| 10063 | [10063] File name is too long. |
| 10064 | [10064] Host is down. |
| 10065 | [10065] No route to host. |
| 10066 | [10066] Directory is not empty |
| 10067 | [10067] Too many processes. |
| 10068 | [10068] Too many users. |
| 10069 | [10069] Disc Quota Exceeded. |
| 10070 | [10070] Stale NFS file handle. |
| 10071 | [10071] Too many levels of remote in path. |
| 10091 | [10091] Network subsystem is unavailable. |
| 10092 | [10092] WINSOCK DLL Version out of range. |
| 10093 | [10093] Winsock is not loaded yet. |
| 11001 | [11001] Host not found. |
| 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
| 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
| 11004 | [11004] Valid name, no data record (check DNS setup). |