OData Class

Properties   Methods   Events   Config Settings   Errors  

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.

Syntax

OData

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 event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.

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

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

To create a new entry, you can set the ServiceRootURI to the service's root URI and ResourcePath 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 can then be called to create the entry.

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

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

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

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

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

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

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

Property List

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

Method List

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

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.

Config Settings

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

Authorization Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorization();
int SetAuthorization(const char* lpszAuthorization);

Unicode (Windows)
LPWSTR GetAuthorization();
INT SetAuthorization(LPCWSTR lpszAuthorization);

char* ipworks_odata_getauthorization(void* lpObj);
int ipworks_odata_setauthorization(void* lpObj, const char* lpszAuthorization);

QString GetAuthorization();
int SetAuthorization(QString qsAuthorization);

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 property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

Data Type

String

AuthScheme Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthScheme();
int SetAuthScheme(int iAuthScheme);

Unicode (Windows)
INT GetAuthScheme();
INT SetAuthScheme(INT iAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5), 
AUTH_OAUTH(6)

int ipworks_odata_getauthscheme(void* lpObj);
int ipworks_odata_setauthscheme(void* lpObj, int iAuthScheme);

int GetAuthScheme();
int SetAuthScheme(int iAuthScheme);

Default Value

0

Remarks

This property will tell the class which type of authorization to perform when the User and Password properties are set.

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

By default, this property is authBasic (0), and if the User and Password properties are set, the 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 property.

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

Note: If you set the Authorization 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, Password, and Authorization.

Data Type

Integer

Channel Property (OData Class)

This includes the feed elements of a feed.

Syntax

• C++
• C
• Qt

IPWorksAtomChannel* GetChannel();
int SetChannel(IPWorksAtomChannel* val);

char* ipworks_odata_getchannelauthoremail(void* lpObj);
int ipworks_odata_setchannelauthoremail(void* lpObj, const char* lpszChannelAuthorEmail);

char* ipworks_odata_getchannelauthorname(void* lpObj);
int ipworks_odata_setchannelauthorname(void* lpObj, const char* lpszChannelAuthorName);

char* ipworks_odata_getchannelauthoruri(void* lpObj);
int ipworks_odata_setchannelauthoruri(void* lpObj, const char* lpszChannelAuthorUri);

char* ipworks_odata_getchannelcategorylabel(void* lpObj);
int ipworks_odata_setchannelcategorylabel(void* lpObj, const char* lpszChannelCategoryLabel);

char* ipworks_odata_getchannelcategoryscheme(void* lpObj);
int ipworks_odata_setchannelcategoryscheme(void* lpObj, const char* lpszChannelCategoryScheme);

char* ipworks_odata_getchannelcategoryterm(void* lpObj);
int ipworks_odata_setchannelcategoryterm(void* lpObj, const char* lpszChannelCategoryTerm);

char* ipworks_odata_getchannelcontributoremail(void* lpObj);
int ipworks_odata_setchannelcontributoremail(void* lpObj, const char* lpszChannelContributorEmail);

char* ipworks_odata_getchannelcontributorname(void* lpObj);
int ipworks_odata_setchannelcontributorname(void* lpObj, const char* lpszChannelContributorName);

char* ipworks_odata_getchannelcontributoruri(void* lpObj);
int ipworks_odata_setchannelcontributoruri(void* lpObj, const char* lpszChannelContributorUri);

char* ipworks_odata_getchannelgenerator(void* lpObj);
int ipworks_odata_setchannelgenerator(void* lpObj, const char* lpszChannelGenerator);

char* ipworks_odata_getchannelicon(void* lpObj);
int ipworks_odata_setchannelicon(void* lpObj, const char* lpszChannelIcon);

char* ipworks_odata_getchannelid(void* lpObj);
int ipworks_odata_setchannelid(void* lpObj, const char* lpszChannelId);

char* ipworks_odata_getchannellinkhref(void* lpObj);
int ipworks_odata_setchannellinkhref(void* lpObj, const char* lpszChannelLinkHref);

char* ipworks_odata_getchannellinkhreflang(void* lpObj);
int ipworks_odata_setchannellinkhreflang(void* lpObj, const char* lpszChannelLinkHrefLang);

char* ipworks_odata_getchannellinklength(void* lpObj);
int ipworks_odata_setchannellinklength(void* lpObj, const char* lpszChannelLinkLength);

char* ipworks_odata_getchannellinkrel(void* lpObj);
int ipworks_odata_setchannellinkrel(void* lpObj, const char* lpszChannelLinkRel);

char* ipworks_odata_getchannellinktitle(void* lpObj);
int ipworks_odata_setchannellinktitle(void* lpObj, const char* lpszChannelLinkTitle);

char* ipworks_odata_getchannellinktype(void* lpObj);
int ipworks_odata_setchannellinktype(void* lpObj, const char* lpszChannelLinkType);

char* ipworks_odata_getchannellogo(void* lpObj);
int ipworks_odata_setchannellogo(void* lpObj, const char* lpszChannelLogo);

char* ipworks_odata_getchannelrights(void* lpObj);
int ipworks_odata_setchannelrights(void* lpObj, const char* lpszChannelRights);

int ipworks_odata_getchannelrightstexttype(void* lpObj);
int ipworks_odata_setchannelrightstexttype(void* lpObj, int iChannelRightsTextType);

char* ipworks_odata_getchannelsubtitle(void* lpObj);
int ipworks_odata_setchannelsubtitle(void* lpObj, const char* lpszChannelSubtitle);

int ipworks_odata_getchannelsubtitletexttype(void* lpObj);
int ipworks_odata_setchannelsubtitletexttype(void* lpObj, int iChannelSubtitleTextType);

char* ipworks_odata_getchanneltitle(void* lpObj);
int ipworks_odata_setchanneltitle(void* lpObj, const char* lpszChannelTitle);

int ipworks_odata_getchanneltitletexttype(void* lpObj);
int ipworks_odata_setchanneltitletexttype(void* lpObj, int iChannelTitleTextType);

char* ipworks_odata_getchannelupdated(void* lpObj);
int ipworks_odata_setchannelupdated(void* lpObj, const char* lpszChannelUpdated);

QString GetChannelAuthorEmail();
int SetChannelAuthorEmail(QString qsChannelAuthorEmail);

QString GetChannelAuthorName();
int SetChannelAuthorName(QString qsChannelAuthorName);

QString GetChannelAuthorUri();
int SetChannelAuthorUri(QString qsChannelAuthorUri);

QString GetChannelCategoryLabel();
int SetChannelCategoryLabel(QString qsChannelCategoryLabel);

QString GetChannelCategoryScheme();
int SetChannelCategoryScheme(QString qsChannelCategoryScheme);

QString GetChannelCategoryTerm();
int SetChannelCategoryTerm(QString qsChannelCategoryTerm);

QString GetChannelContributorEmail();
int SetChannelContributorEmail(QString qsChannelContributorEmail);

QString GetChannelContributorName();
int SetChannelContributorName(QString qsChannelContributorName);

QString GetChannelContributorUri();
int SetChannelContributorUri(QString qsChannelContributorUri);

QString GetChannelGenerator();
int SetChannelGenerator(QString qsChannelGenerator);

QString GetChannelIcon();
int SetChannelIcon(QString qsChannelIcon);

QString GetChannelId();
int SetChannelId(QString qsChannelId);

QString GetChannelLinkHref();
int SetChannelLinkHref(QString qsChannelLinkHref);

QString GetChannelLinkHrefLang();
int SetChannelLinkHrefLang(QString qsChannelLinkHrefLang);

QString GetChannelLinkLength();
int SetChannelLinkLength(QString qsChannelLinkLength);

QString GetChannelLinkRel();
int SetChannelLinkRel(QString qsChannelLinkRel);

QString GetChannelLinkTitle();
int SetChannelLinkTitle(QString qsChannelLinkTitle);

QString GetChannelLinkType();
int SetChannelLinkType(QString qsChannelLinkType);

QString GetChannelLogo();
int SetChannelLogo(QString qsChannelLogo);

QString GetChannelRights();
int SetChannelRights(QString qsChannelRights);

int GetChannelRightsTextType();
int SetChannelRightsTextType(int iChannelRightsTextType);

QString GetChannelSubtitle();
int SetChannelSubtitle(QString qsChannelSubtitle);

int GetChannelSubtitleTextType();
int SetChannelSubtitleTextType(int iChannelSubtitleTextType);

QString GetChannelTitle();
int SetChannelTitle(QString qsChannelTitle);

int GetChannelTitleTextType();
int SetChannelTitleTextType(int iChannelTitleTextType);

QString GetChannelUpdated();
int SetChannelUpdated(QString qsChannelUpdated);

Remarks

This property contains the "feed" elements of an ATOM feed. The Channel property has fields that contain values for subelements of the "feed" element.

Data Type

IPWorksAtomChannel

Cookies Property (OData Class)

A collection of cookies.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksHTTPCookie>* GetCookies();
int SetCookies(IPWorksList<IPWorksHTTPCookie>* val);

int ipworks_odata_getcookiecount(void* lpObj);
int ipworks_odata_setcookiecount(void* lpObj, int iCookieCount);

char* ipworks_odata_getcookiedomain(void* lpObj, int cookieindex);

char* ipworks_odata_getcookieexpiration(void* lpObj, int cookieindex);

char* ipworks_odata_getcookiename(void* lpObj, int cookieindex);
int ipworks_odata_setcookiename(void* lpObj, int cookieindex, const char* lpszCookieName);

char* ipworks_odata_getcookiepath(void* lpObj, int cookieindex);

int ipworks_odata_getcookiesecure(void* lpObj, int cookieindex);

char* ipworks_odata_getcookievalue(void* lpObj, int cookieindex);
int ipworks_odata_setcookievalue(void* lpObj, int cookieindex, const char* lpszCookieValue);

int GetCookieCount();
int SetCookieCount(int iCookieCount);

QString GetCookieDomain(int iCookieIndex);

QString GetCookieExpiration(int iCookieIndex);

QString GetCookieName(int iCookieIndex);
int SetCookieName(int iCookieIndex, QString qsCookieName);

QString GetCookiePath(int iCookieIndex);

bool GetCookieSecure(int iCookieIndex);

QString GetCookieValue(int iCookieIndex);
int SetCookieValue(int iCookieIndex, QString qsCookieValue);

Remarks

This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type HTTPCookie) to this collection.

To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies.

MaxHTTPCookies can be used to control the maximum number of cookies saved.

This property is not available at design time.

Data Type

IPWorksHTTPCookie

EntryAuthor Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryAuthor();
int SetEntryAuthor(const char* lpszEntryAuthor);

Unicode (Windows)
LPWSTR GetEntryAuthor();
INT SetEntryAuthor(LPCWSTR lpszEntryAuthor);

char* ipworks_odata_getentryauthor(void* lpObj);
int ipworks_odata_setentryauthor(void* lpObj, const char* lpszEntryAuthor);

QString GetEntryAuthor();
int SetEntryAuthor(QString qsEntryAuthor);

Default Value

""

Remarks

This property contains the author of the specified entry within an OData feed. This value will be populated once EntryIndex 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 (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEntryCount();

Unicode (Windows)
INT GetEntryCount();

int ipworks_odata_getentrycount(void* lpObj);

int GetEntryCount();

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 (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryETag();
int SetEntryETag(const char* lpszEntryETag);

Unicode (Windows)
LPWSTR GetEntryETag();
INT SetEntryETag(LPCWSTR lpszEntryETag);

char* ipworks_odata_getentryetag(void* lpObj);
int ipworks_odata_setentryetag(void* lpObj, const char* lpszEntryETag);

QString GetEntryETag();
int SetEntryETag(QString qsEntryETag);

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 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 is called. When DeleteEntry or UpdateEntry 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 (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryId();
int SetEntryId(const char* lpszEntryId);

Unicode (Windows)
LPWSTR GetEntryId();
INT SetEntryId(LPCWSTR lpszEntryId);

char* ipworks_odata_getentryid(void* lpObj);
int ipworks_odata_setentryid(void* lpObj, const char* lpszEntryId);

QString GetEntryId();
int SetEntryId(QString qsEntryId);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

EntryIndex Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEntryIndex();
int SetEntryIndex(int iEntryIndex);

Unicode (Windows)
INT GetEntryIndex();
INT SetEntryIndex(INT iEntryIndex);

int ipworks_odata_getentryindex(void* lpObj);
int ipworks_odata_setentryindex(void* lpObj, int iEntryIndex);

int GetEntryIndex();
int SetEntryIndex(int iEntryIndex);

Default Value

-1

Remarks

This property is used to specify an entry within a retrieved OData feed. Once set, EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties, and ResourcePath will be populated with their respective values found within the entry.

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

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

This property is not available at design time.

Data Type

Integer

EntryLinks Property (OData Class)

This property includes a collection of links in the current OData entry.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksODataEntryLink>* GetEntryLinks();
int SetEntryLinks(IPWorksList<IPWorksODataEntryLink>* val);

int ipworks_odata_getentrylinkscount(void* lpObj);
int ipworks_odata_setentrylinkscount(void* lpObj, int iEntryLinksCount);

char* ipworks_odata_getentrylinksresourcepath(void* lpObj, int entrylinksindex);

char* ipworks_odata_getentrylinkstitle(void* lpObj, int entrylinksindex);

int GetEntryLinksCount();
int SetEntryLinksCount(int iEntryLinksCount);

QString GetEntryLinksResourcePath(int iEntryLinksIndex);

QString GetEntryLinksTitle(int iEntryLinksIndex);

Remarks

This is a collection of links (referred to as Navigation Properties) in the current OData entry, as specified by EntryIndex. When EntryIndex is set, all of the elements in the entry are stored as ODataEntryLink types in this collection.

Data Type

IPWorksODataEntryLink

EntryProperties Property (OData Class)

This property includes a collection of elements in the current OData entry.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksODataEntryProperty>* GetEntryProperties();
int SetEntryProperties(IPWorksList<IPWorksODataEntryProperty>* val);

int ipworks_odata_getentrypropertiescount(void* lpObj);
int ipworks_odata_setentrypropertiescount(void* lpObj, int iEntryPropertiesCount);

char* ipworks_odata_getentrypropertiesattributes(void* lpObj, int entrypropertiesindex);
int ipworks_odata_setentrypropertiesattributes(void* lpObj, int entrypropertiesindex, const char* lpszEntryPropertiesAttributes);

int ipworks_odata_getentrypropertiesisnull(void* lpObj, int entrypropertiesindex);
int ipworks_odata_setentrypropertiesisnull(void* lpObj, int entrypropertiesindex, int bEntryPropertiesIsNull);

char* ipworks_odata_getentrypropertiesname(void* lpObj, int entrypropertiesindex);
int ipworks_odata_setentrypropertiesname(void* lpObj, int entrypropertiesindex, const char* lpszEntryPropertiesName);

char* ipworks_odata_getentrypropertiestype(void* lpObj, int entrypropertiesindex);
int ipworks_odata_setentrypropertiestype(void* lpObj, int entrypropertiesindex, const char* lpszEntryPropertiesType);

char* ipworks_odata_getentrypropertiesvalue(void* lpObj, int entrypropertiesindex);
int ipworks_odata_setentrypropertiesvalue(void* lpObj, int entrypropertiesindex, const char* lpszEntryPropertiesValue);

char* ipworks_odata_getentrypropertiesxpath(void* lpObj, int entrypropertiesindex);

int GetEntryPropertiesCount();
int SetEntryPropertiesCount(int iEntryPropertiesCount);

QString GetEntryPropertiesAttributes(int iEntryPropertiesIndex);
int SetEntryPropertiesAttributes(int iEntryPropertiesIndex, QString qsEntryPropertiesAttributes);

bool GetEntryPropertiesIsNull(int iEntryPropertiesIndex);
int SetEntryPropertiesIsNull(int iEntryPropertiesIndex, bool bEntryPropertiesIsNull);

QString GetEntryPropertiesName(int iEntryPropertiesIndex);
int SetEntryPropertiesName(int iEntryPropertiesIndex, QString qsEntryPropertiesName);

QString GetEntryPropertiesType(int iEntryPropertiesIndex);
int SetEntryPropertiesType(int iEntryPropertiesIndex, QString qsEntryPropertiesType);

QString GetEntryPropertiesValue(int iEntryPropertiesIndex);
int SetEntryPropertiesValue(int iEntryPropertiesIndex, QString qsEntryPropertiesValue);

QString GetEntryPropertiesXPath(int iEntryPropertiesIndex);

Remarks

This is a collection of elements in the current OData entry, as specified by EntryIndex. When EntryIndex is set, all of the elements in the entry are stored as ODataEntryProperty types in this collection.

Data Type

IPWorksODataEntryProperty

EntrySummary Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntrySummary();
int SetEntrySummary(const char* lpszEntrySummary);

Unicode (Windows)
LPWSTR GetEntrySummary();
INT SetEntrySummary(LPCWSTR lpszEntrySummary);

char* ipworks_odata_getentrysummary(void* lpObj);
int ipworks_odata_setentrysummary(void* lpObj, const char* lpszEntrySummary);

QString GetEntrySummary();
int SetEntrySummary(QString qsEntrySummary);

Default Value

""

Remarks

This property contains the summary of a specified entry within an OData feed. This value will be populated once EntryIndex 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 (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryTitle();
int SetEntryTitle(const char* lpszEntryTitle);

Unicode (Windows)
LPWSTR GetEntryTitle();
INT SetEntryTitle(LPCWSTR lpszEntryTitle);

char* ipworks_odata_getentrytitle(void* lpObj);
int ipworks_odata_setentrytitle(void* lpObj, const char* lpszEntryTitle);

QString GetEntryTitle();
int SetEntryTitle(QString qsEntryTitle);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

EntryType Property (OData Class)

This property includes the entry category or type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryType();
int SetEntryType(const char* lpszEntryType);

Unicode (Windows)
LPWSTR GetEntryType();
INT SetEntryType(LPCWSTR lpszEntryType);

char* ipworks_odata_getentrytype(void* lpObj);
int ipworks_odata_setentrytype(void* lpObj, const char* lpszEntryType);

QString GetEntryType();
int SetEntryType(QString qsEntryType);

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 (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryUpdated();

Unicode (Windows)
LPWSTR GetEntryUpdated();

char* ipworks_odata_getentryupdated(void* lpObj);

QString GetEntryUpdated();

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 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 (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryXML();
int SetEntryXML(const char* lpszEntryXML);

Unicode (Windows)
LPWSTR GetEntryXML();
INT SetEntryXML(LPCWSTR lpszEntryXML);

char* ipworks_odata_getentryxml(void* lpObj);
int ipworks_odata_setentryxml(void* lpObj, const char* lpszEntryXML);

QString GetEntryXML();
int SetEntryXML(QString qsEntryXML);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

Firewall Property (OData Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

IPWorksFirewall* GetFirewall();
int SetFirewall(IPWorksFirewall* val);

int ipworks_odata_getfirewallautodetect(void* lpObj);
int ipworks_odata_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworks_odata_getfirewalltype(void* lpObj);
int ipworks_odata_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworks_odata_getfirewallhost(void* lpObj);
int ipworks_odata_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworks_odata_getfirewallpassword(void* lpObj);
int ipworks_odata_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworks_odata_getfirewallport(void* lpObj);
int ipworks_odata_setfirewallport(void* lpObj, int iFirewallPort);

char* ipworks_odata_getfirewalluser(void* lpObj);
int ipworks_odata_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

IPWorksFirewall

Idle Property (OData Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworks_odata_getidle(void* lpObj);

bool GetIdle();

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 (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworks_odata_getlocalhost(void* lpObj);
int ipworks_odata_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

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 classs) 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 (OData Class)

This property includes the OData version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetODataVersion();
int SetODataVersion(int iODataVersion);

Unicode (Windows)
INT GetODataVersion();
INT SetODataVersion(INT iODataVersion);

OD_V2(0), 
OD_V3(1), 
OD_V4(2), 
OD_AUTO(3)

int ipworks_odata_getodataversion(void* lpObj);
int ipworks_odata_setodataversion(void* lpObj, int iODataVersion);

int GetODataVersion();
int SetODataVersion(int iODataVersion);

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)

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

This property is not available at design time.

Data Type

Integer

OtherHeaders Property (OData Class)

Other headers as determined by the user (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders);

Unicode (Windows)
LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);

char* ipworks_odata_getotherheaders(void* lpObj);
int ipworks_odata_setotherheaders(void* lpObj, const char* lpszOtherHeaders);

QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);

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 (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOtherQueryOptions();
int SetOtherQueryOptions(const char* lpszOtherQueryOptions);

Unicode (Windows)
LPWSTR GetOtherQueryOptions();
INT SetOtherQueryOptions(LPCWSTR lpszOtherQueryOptions);

char* ipworks_odata_getotherqueryoptions(void* lpObj);
int ipworks_odata_setotherqueryoptions(void* lpObj, const char* lpszOtherQueryOptions);

QString GetOtherQueryOptions();
int SetOtherQueryOptions(QString qsOtherQueryOptions);

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, ResourcePath, and any Query*** properties specified).

This property is not available at design time.

Data Type

String

ParsedHeaders Property (OData Class)

This property includes a collection of headers returned from the last request.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksHeader>* GetParsedHeaders();

int ipworks_odata_getparsedheadercount(void* lpObj);

char* ipworks_odata_getparsedheaderfield(void* lpObj, int parsedheaderindex);

char* ipworks_odata_getparsedheadervalue(void* lpObj, int parsedheaderindex);

int GetParsedHeaderCount();

QString GetParsedHeaderField(int iParsedHeaderIndex);

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

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

Data Type

IPWorksHeader

Password Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworks_odata_getpassword(void* lpObj);
int ipworks_odata_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

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

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the class will attempt to authenticate using the current user's credentials.

Data Type

String

Proxy Property (OData Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

IPWorksProxy* GetProxy();
int SetProxy(IPWorksProxy* val);

int ipworks_odata_getproxyauthscheme(void* lpObj);
int ipworks_odata_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int ipworks_odata_getproxyautodetect(void* lpObj);
int ipworks_odata_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* ipworks_odata_getproxypassword(void* lpObj);
int ipworks_odata_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int ipworks_odata_getproxyport(void* lpObj);
int ipworks_odata_setproxyport(void* lpObj, int iProxyPort);

char* ipworks_odata_getproxyserver(void* lpObj);
int ipworks_odata_setproxyserver(void* lpObj, const char* lpszProxyServer);

int ipworks_odata_getproxyssl(void* lpObj);
int ipworks_odata_setproxyssl(void* lpObj, int iProxySSL);

char* ipworks_odata_getproxyuser(void* lpObj);
int ipworks_odata_setproxyuser(void* lpObj, const char* lpszProxyUser);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Data Type

IPWorksProxy

QueryFilter Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQueryFilter();
int SetQueryFilter(const char* lpszQueryFilter);

Unicode (Windows)
LPWSTR GetQueryFilter();
INT SetQueryFilter(LPCWSTR lpszQueryFilter);

char* ipworks_odata_getqueryfilter(void* lpObj);
int ipworks_odata_setqueryfilter(void* lpObj, const char* lpszQueryFilter);

QString GetQueryFilter();
int SetQueryFilter(QString qsQueryFilter);

Default Value

""

Remarks

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

The following operators are supported in the expression language.

Logical Operators

Arithmetic Operators

Grouping Operators

The following functions are supported in the expression language.

String Functions

Date Functions

Math Functions

Type Functions

This property is not available at design time.

Data Type

String

QueryOrderBy Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQueryOrderBy();
int SetQueryOrderBy(const char* lpszQueryOrderBy);

Unicode (Windows)
LPWSTR GetQueryOrderBy();
INT SetQueryOrderBy(LPCWSTR lpszQueryOrderBy);

char* ipworks_odata_getqueryorderby(void* lpObj);
int ipworks_odata_setqueryorderby(void* lpObj, const char* lpszQueryOrderBy);

QString GetQueryOrderBy();
int SetQueryOrderBy(QString qsQueryOrderBy);

Default Value

""

Remarks

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

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 (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQuerySelect();
int SetQuerySelect(const char* lpszQuerySelect);

Unicode (Windows)
LPWSTR GetQuerySelect();
INT SetQuerySelect(LPCWSTR lpszQuerySelect);

char* ipworks_odata_getqueryselect(void* lpObj);
int ipworks_odata_setqueryselect(void* lpObj, const char* lpszQuerySelect);

QString GetQuerySelect();
int SetQuerySelect(QString qsQuerySelect);

Default Value

""

Remarks

This property allows you to specify the specific properties you want returned within an entry when calling QueryService. 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 (Title), or the "*" character, which returns all the properties for each entry.

This property is not available at design time.

Data Type

String

QuerySkip Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQuerySkip();
int SetQuerySkip(const char* lpszQuerySkip);

Unicode (Windows)
LPWSTR GetQuerySkip();
INT SetQuerySkip(LPCWSTR lpszQuerySkip);

char* ipworks_odata_getqueryskip(void* lpObj);
int ipworks_odata_setqueryskip(void* lpObj, const char* lpszQuerySkip);

QString GetQuerySkip();
int SetQuerySkip(QString qsQuerySkip);

Default Value

""

Remarks

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

This property can be used in conjunction with QueryOrderBy and QueryTop to select specific entries. For example, if you wanted to select the third and fourth highest rated item you would set QueryOrderBy 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 to 2 (to return only the third and fourth items).

This property is not available at design time.

Data Type

String

QuerySkipToken Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQuerySkipToken();
int SetQuerySkipToken(const char* lpszQuerySkipToken);

Unicode (Windows)
LPWSTR GetQuerySkipToken();
INT SetQuerySkipToken(LPCWSTR lpszQuerySkipToken);

char* ipworks_odata_getqueryskiptoken(void* lpObj);
int ipworks_odata_setqueryskiptoken(void* lpObj, const char* lpszQuerySkipToken);

QString GetQuerySkipToken();
int SetQuerySkipToken(QString qsQuerySkipToken);

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 again will return the next page of results.

This property is not available at design time.

Data Type

String

QueryTop Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQueryTop();
int SetQueryTop(const char* lpszQueryTop);

Unicode (Windows)
LPWSTR GetQueryTop();
INT SetQueryTop(LPCWSTR lpszQueryTop);

char* ipworks_odata_getquerytop(void* lpObj);
int ipworks_odata_setquerytop(void* lpObj, const char* lpszQueryTop);

QString GetQueryTop();
int SetQueryTop(QString qsQueryTop);

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. 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 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 (OData Class)

This property includes the resource path of an OData service.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResourcePath();
int SetResourcePath(const char* lpszResourcePath);

Unicode (Windows)
LPWSTR GetResourcePath();
INT SetResourcePath(LPCWSTR lpszResourcePath);

char* ipworks_odata_getresourcepath(void* lpObj);
int ipworks_odata_setresourcepath(void* lpObj, const char* lpszResourcePath);

QString GetResourcePath();
int SetResourcePath(QString qsResourcePath);

Default Value

""

Remarks

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

This property will be populated when EntryIndex 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

SchemaAssociation Property (OData Class)

This property includes the navigation properties and their corresponding associations contained within an entity of a service schema.

Syntax

• C++
• C
• Qt

IPWorksODataSchemaAssociation* GetSchemaAssociation();

int ipworks_odata_getschemaassociationcontainstarget(void* lpObj);

char* ipworks_odata_getschemaassociationdescription(void* lpObj);

char* ipworks_odata_getschemaassociationfromrole(void* lpObj);

char* ipworks_odata_getschemaassociationfromroledescription(void* lpObj);

char* ipworks_odata_getschemaassociationfromroleentity(void* lpObj);

int ipworks_odata_getschemaassociationfromrolemultiplicity(void* lpObj);

char* ipworks_odata_getschemaassociationfromrolesummary(void* lpObj);

char* ipworks_odata_getschemaassociationname(void* lpObj);

int ipworks_odata_getschemaassociationnullable(void* lpObj);

int ipworks_odata_getschemaassociationondelete(void* lpObj);

char* ipworks_odata_getschemaassociationpartner(void* lpObj);

int ipworks_odata_getschemaassociationrefconstraintcount(void* lpObj);

int ipworks_odata_getschemaassociationrefconstraintindex(void* lpObj);
int ipworks_odata_setschemaassociationrefconstraintindex(void* lpObj, int iSchemaAssociationRefConstraintIndex);

char* ipworks_odata_getschemaassociationrefconstraintproperty(void* lpObj);

char* ipworks_odata_getschemaassociationrefconstraintreferencedproperty(void* lpObj);

char* ipworks_odata_getschemaassociationrelationship(void* lpObj);

char* ipworks_odata_getschemaassociationsummary(void* lpObj);

char* ipworks_odata_getschemaassociationtorole(void* lpObj);

char* ipworks_odata_getschemaassociationtoroledescription(void* lpObj);

char* ipworks_odata_getschemaassociationtoroleentity(void* lpObj);

int ipworks_odata_getschemaassociationtorolemultiplicity(void* lpObj);

char* ipworks_odata_getschemaassociationtorolesummary(void* lpObj);

char* ipworks_odata_getschemaassociationtype(void* lpObj);

bool GetSchemaAssociationContainsTarget();

QString GetSchemaAssociationDescription();

QString GetSchemaAssociationFromRole();

QString GetSchemaAssociationFromRoleDescription();

QString GetSchemaAssociationFromRoleEntity();

int GetSchemaAssociationFromRoleMultiplicity();

QString GetSchemaAssociationFromRoleSummary();

QString GetSchemaAssociationName();

bool GetSchemaAssociationNullable();

int GetSchemaAssociationOnDelete();

QString GetSchemaAssociationPartner();

int GetSchemaAssociationRefConstraintCount();

int GetSchemaAssociationRefConstraintIndex();
int SetSchemaAssociationRefConstraintIndex(int iSchemaAssociationRefConstraintIndex);

QString GetSchemaAssociationRefConstraintProperty();

QString GetSchemaAssociationRefConstraintReferencedProperty();

QString GetSchemaAssociationRelationship();

QString GetSchemaAssociationSummary();

QString GetSchemaAssociationToRole();

QString GetSchemaAssociationToRoleDescription();

QString GetSchemaAssociationToRoleEntity();

int GetSchemaAssociationToRoleMultiplicity();

QString GetSchemaAssociationToRoleSummary();

QString GetSchemaAssociationType();

Remarks

This property is used to obtain the navigation properties and their corresponding associations contained within an entity (specified by SchemaEntityIndex) of a service schema. This property is populated after setting SchemaAssociationIndex.

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

Data Type

IPWorksODataSchemaAssociation

SchemaAssociationCount Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSchemaAssociationCount();

Unicode (Windows)
INT GetSchemaAssociationCount();

int ipworks_odata_getschemaassociationcount(void* lpObj);

int GetSchemaAssociationCount();

Default Value

0

Remarks

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

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

Data Type

Integer

SchemaAssociationIndex Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSchemaAssociationIndex();
int SetSchemaAssociationIndex(int iSchemaAssociationIndex);

Unicode (Windows)
INT GetSchemaAssociationIndex();
INT SetSchemaAssociationIndex(INT iSchemaAssociationIndex);

int ipworks_odata_getschemaassociationindex(void* lpObj);
int ipworks_odata_setschemaassociationindex(void* lpObj, int iSchemaAssociationIndex);

int GetSchemaAssociationIndex();
int SetSchemaAssociationIndex(int iSchemaAssociationIndex);

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

SchemaEntity Property (OData Class)

This property includes the entities contained within a service schema.

Syntax

• C++
• C
• Qt

IPWorksODataSchemaEntity* GetSchemaEntity();

char* ipworks_odata_getschemaentitydescription(void* lpObj);

char* ipworks_odata_getschemaentityname(void* lpObj);

char* ipworks_odata_getschemaentitysummary(void* lpObj);

QString GetSchemaEntityDescription();

QString GetSchemaEntityName();

QString GetSchemaEntitySummary();

Remarks

This property is used to obtain the entities of a service schema. This property is populated after setting SchemaEntityIndex.

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

Data Type

IPWorksODataSchemaEntity

SchemaEntityCount Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSchemaEntityCount();

Unicode (Windows)
INT GetSchemaEntityCount();

int ipworks_odata_getschemaentitycount(void* lpObj);

int GetSchemaEntityCount();

Default Value

0

Remarks

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

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

Data Type

Integer

SchemaEntityIndex Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSchemaEntityIndex();
int SetSchemaEntityIndex(int iSchemaEntityIndex);

Unicode (Windows)
INT GetSchemaEntityIndex();
INT SetSchemaEntityIndex(INT iSchemaEntityIndex);

int ipworks_odata_getschemaentityindex(void* lpObj);
int ipworks_odata_setschemaentityindex(void* lpObj, int iSchemaEntityIndex);

int GetSchemaEntityIndex();
int SetSchemaEntityIndex(int iSchemaEntityIndex);

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 (OData Class)

The number of records in the SchemaKeys array.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSchemaKeysCount();

Unicode (Windows)
INT GetSchemaKeysCount();

int ipworks_odata_getschemakeyscount(void* lpObj);

int GetSchemaKeysCount();

Default Value

0

Remarks

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

Data Type

Integer

SchemaKeys Property (OData Class)

This property includes the keys for a schema entity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSchemaKeys(int iSchemaKeysIndex);

Unicode (Windows)
LPWSTR GetSchemaKeys(INT iSchemaKeysIndex);

char* ipworks_odata_getschemakeys(void* lpObj, int schemakeysindex);

QString GetSchemaKeys(int iSchemaKeysIndex);

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.

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

SchemaProperty Property (OData Class)

This property includes the properties contained within an entity of a service schema.

Syntax

• C++
• C
• Qt

IPWorksODataSchemaProperty* GetSchemaProperty();

char* ipworks_odata_getschemapropertyattributes(void* lpObj);

char* ipworks_odata_getschemapropertydescription(void* lpObj);

int ipworks_odata_getschemapropertyiscomplextype(void* lpObj);

char* ipworks_odata_getschemapropertyname(void* lpObj);

int ipworks_odata_getschemapropertynullable(void* lpObj);

char* ipworks_odata_getschemapropertysummary(void* lpObj);

char* ipworks_odata_getschemapropertytype(void* lpObj);

QString GetSchemaPropertyAttributes();

QString GetSchemaPropertyDescription();

bool GetSchemaPropertyIsComplexType();

QString GetSchemaPropertyName();

bool GetSchemaPropertyNullable();

QString GetSchemaPropertySummary();

QString GetSchemaPropertyType();

Remarks

This property is used to obtain the properties contained within an entity (specified by SchemaEntityIndex) of a service schema. This property is populated after setting SchemaPropertyIndex.

Note: In reference to a database structure, a property would be a column.

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

Data Type

IPWorksODataSchemaProperty

SchemaPropertyCount Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSchemaPropertyCount();

Unicode (Windows)
INT GetSchemaPropertyCount();

int ipworks_odata_getschemapropertycount(void* lpObj);

int GetSchemaPropertyCount();

Default Value

0

Remarks

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

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

Data Type

Integer

SchemaPropertyIndex Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSchemaPropertyIndex();
int SetSchemaPropertyIndex(int iSchemaPropertyIndex);

Unicode (Windows)
INT GetSchemaPropertyIndex();
INT SetSchemaPropertyIndex(INT iSchemaPropertyIndex);

int ipworks_odata_getschemapropertyindex(void* lpObj);
int ipworks_odata_setschemapropertyindex(void* lpObj, int iSchemaPropertyIndex);

int GetSchemaPropertyIndex();
int SetSchemaPropertyIndex(int iSchemaPropertyIndex);

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

SchemaTypeField Property (OData Class)

This property includes the fields (properties) contained within a complex type.

Syntax

• C++
• C
• Qt

IPWorksODataSchemaProperty* GetSchemaTypeField();

char* ipworks_odata_getschematypefieldattributes(void* lpObj);

char* ipworks_odata_getschematypefielddescription(void* lpObj);

int ipworks_odata_getschematypefieldiscomplextype(void* lpObj);

char* ipworks_odata_getschematypefieldname(void* lpObj);

int ipworks_odata_getschematypefieldnullable(void* lpObj);

char* ipworks_odata_getschematypefieldsummary(void* lpObj);

char* ipworks_odata_getschematypefieldtype(void* lpObj);

QString GetSchemaTypeFieldAttributes();

QString GetSchemaTypeFieldDescription();

bool GetSchemaTypeFieldIsComplexType();

QString GetSchemaTypeFieldName();

bool GetSchemaTypeFieldNullable();

QString GetSchemaTypeFieldSummary();

QString GetSchemaTypeFieldType();

Remarks

This property is used to obtain the fields (properties) contained within a complex type.

Note: It is populated when navigating an entity's properties via SchemaPropertyIndex or by explicitly setting the complex type name via SetSchemaType.

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

Data Type

IPWorksODataSchemaProperty

SchemaTypeFieldCount Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSchemaTypeFieldCount();

Unicode (Windows)
INT GetSchemaTypeFieldCount();

int ipworks_odata_getschematypefieldcount(void* lpObj);

int GetSchemaTypeFieldCount();

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 or by explicitly setting the type via SetSchemaType.

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

Data Type

Integer

SchemaTypeFieldIndex Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSchemaTypeFieldIndex();
int SetSchemaTypeFieldIndex(int iSchemaTypeFieldIndex);

Unicode (Windows)
INT GetSchemaTypeFieldIndex();
INT SetSchemaTypeFieldIndex(INT iSchemaTypeFieldIndex);

int ipworks_odata_getschematypefieldindex(void* lpObj);
int ipworks_odata_setschematypefieldindex(void* lpObj, int iSchemaTypeFieldIndex);

int GetSchemaTypeFieldIndex();
int SetSchemaTypeFieldIndex(int iSchemaTypeFieldIndex);

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 (OData Class)

This property includes the root URI of an OData service.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceRootURI();
int SetServiceRootURI(const char* lpszServiceRootURI);

Unicode (Windows)
LPWSTR GetServiceRootURI();
INT SetServiceRootURI(LPCWSTR lpszServiceRootURI);

char* ipworks_odata_getservicerooturi(void* lpObj);
int ipworks_odata_setservicerooturi(void* lpObj, const char* lpszServiceRootURI);

QString GetServiceRootURI();
int SetServiceRootURI(QString qsServiceRootURI);

Default Value

""

Remarks

This property contains the root URI of an OData service. This value is used in conjunction with ResourcePath (ServiceRootURI/ResourcePath) 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

SSLAcceptServerCert Property (OData Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorksCertificate* val);

char* ipworks_odata_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworks_odata_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworks_odata_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworks_odata_getsslacceptservercertfingerprint(void* lpObj);

char* ipworks_odata_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworks_odata_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworks_odata_getsslacceptservercertissuer(void* lpObj);

char* ipworks_odata_getsslacceptservercertprivatekey(void* lpObj);

int ipworks_odata_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworks_odata_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworks_odata_getsslacceptservercertpublickey(void* lpObj);

char* ipworks_odata_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworks_odata_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworks_odata_getsslacceptservercertserialnumber(void* lpObj);

char* ipworks_odata_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworks_odata_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworks_odata_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworks_odata_getsslacceptservercertstorepassword(void* lpObj);
int ipworks_odata_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworks_odata_getsslacceptservercertstoretype(void* lpObj);
int ipworks_odata_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworks_odata_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworks_odata_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworks_odata_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworks_odata_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworks_odata_getsslacceptservercertusage(void* lpObj);

int ipworks_odata_getsslacceptservercertusageflags(void* lpObj);

char* ipworks_odata_getsslacceptservercertversion(void* lpObj);

char* ipworks_odata_getsslacceptservercertsubject(void* lpObj);
int ipworks_odata_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworks_odata_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworks_odata_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

IPWorksCertificate

SSLCert Property (OData Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLCert();
int SetSSLCert(IPWorksCertificate* val);

char* ipworks_odata_getsslcerteffectivedate(void* lpObj);

char* ipworks_odata_getsslcertexpirationdate(void* lpObj);

char* ipworks_odata_getsslcertextendedkeyusage(void* lpObj);

char* ipworks_odata_getsslcertfingerprint(void* lpObj);

char* ipworks_odata_getsslcertfingerprintsha1(void* lpObj);

char* ipworks_odata_getsslcertfingerprintsha256(void* lpObj);

char* ipworks_odata_getsslcertissuer(void* lpObj);

char* ipworks_odata_getsslcertprivatekey(void* lpObj);

int ipworks_odata_getsslcertprivatekeyavailable(void* lpObj);

char* ipworks_odata_getsslcertprivatekeycontainer(void* lpObj);

char* ipworks_odata_getsslcertpublickey(void* lpObj);

char* ipworks_odata_getsslcertpublickeyalgorithm(void* lpObj);

int ipworks_odata_getsslcertpublickeylength(void* lpObj);

char* ipworks_odata_getsslcertserialnumber(void* lpObj);

char* ipworks_odata_getsslcertsignaturealgorithm(void* lpObj);

int ipworks_odata_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworks_odata_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworks_odata_getsslcertstorepassword(void* lpObj);
int ipworks_odata_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworks_odata_getsslcertstoretype(void* lpObj);
int ipworks_odata_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworks_odata_getsslcertsubjectaltnames(void* lpObj);

char* ipworks_odata_getsslcertthumbprintmd5(void* lpObj);

char* ipworks_odata_getsslcertthumbprintsha1(void* lpObj);

char* ipworks_odata_getsslcertthumbprintsha256(void* lpObj);

char* ipworks_odata_getsslcertusage(void* lpObj);

int ipworks_odata_getsslcertusageflags(void* lpObj);

char* ipworks_odata_getsslcertversion(void* lpObj);

char* ipworks_odata_getsslcertsubject(void* lpObj);
int ipworks_odata_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworks_odata_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworks_odata_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

IPWorksCertificate

SSLProvider Property (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworks_odata_getsslprovider(void* lpObj);
int ipworks_odata_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

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:

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, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCert Property (OData Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLServerCert();

char* ipworks_odata_getsslservercerteffectivedate(void* lpObj);

char* ipworks_odata_getsslservercertexpirationdate(void* lpObj);

char* ipworks_odata_getsslservercertextendedkeyusage(void* lpObj);

char* ipworks_odata_getsslservercertfingerprint(void* lpObj);

char* ipworks_odata_getsslservercertfingerprintsha1(void* lpObj);

char* ipworks_odata_getsslservercertfingerprintsha256(void* lpObj);

char* ipworks_odata_getsslservercertissuer(void* lpObj);

char* ipworks_odata_getsslservercertprivatekey(void* lpObj);

int ipworks_odata_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworks_odata_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworks_odata_getsslservercertpublickey(void* lpObj);

char* ipworks_odata_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworks_odata_getsslservercertpublickeylength(void* lpObj);

char* ipworks_odata_getsslservercertserialnumber(void* lpObj);

char* ipworks_odata_getsslservercertsignaturealgorithm(void* lpObj);

int ipworks_odata_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* ipworks_odata_getsslservercertstorepassword(void* lpObj);

int ipworks_odata_getsslservercertstoretype(void* lpObj);

char* ipworks_odata_getsslservercertsubjectaltnames(void* lpObj);

char* ipworks_odata_getsslservercertthumbprintmd5(void* lpObj);

char* ipworks_odata_getsslservercertthumbprintsha1(void* lpObj);

char* ipworks_odata_getsslservercertthumbprintsha256(void* lpObj);

char* ipworks_odata_getsslservercertusage(void* lpObj);

int ipworks_odata_getsslservercertusageflags(void* lpObj);

char* ipworks_odata_getsslservercertversion(void* lpObj);

char* ipworks_odata_getsslservercertsubject(void* lpObj);

int ipworks_odata_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksCertificate

Timeout Property (OData Class)

The timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworks_odata_gettimeout(void* lpObj);
int ipworks_odata_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

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 (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTransferredData(char* &lpTransferredData, int &lenTransferredData);

Unicode (Windows)
INT GetTransferredData(LPSTR &lpTransferredData, INT &lenTransferredData);

int ipworks_odata_gettransferreddata(void* lpObj, char** lpTransferredData, int* lenTransferredData);

QByteArray GetTransferredData();

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 or CustomRequest 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 (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* ipworks_odata_getuser(void* lpObj);
int ipworks_odata_setuser(void* lpObj, const char* lpszUser);

QString GetUser();
int SetUser(QString qsUser);

Default Value

""

Remarks

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

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM, and User and Password are empty, the class will attempt to authenticate using the current user's credentials.

Data Type

String

Config Method (OData Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworks_odata_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings 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, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateEntry Method (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateEntry();

Unicode (Windows)
INT CreateEntry();

int ipworks_odata_createentry(void* lpObj);

int CreateEntry();

Remarks

The component will use the items contained within EntryProperties to create a new entry within the feed service resource by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath).

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 will then be set to 0 (the first entry within the response), populating the EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, and EntryProperties properties. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CustomRequest Method (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CustomRequest(const char* lpszHTTPMethod, const char* lpszURL, const char* lpszPostData);

Unicode (Windows)
INT CustomRequest(LPCWSTR lpszHTTPMethod, LPCWSTR lpszURL, LPCWSTR lpszPostData);

int ipworks_odata_customrequest(void* lpObj, const char* lpszHTTPMethod, const char* lpszURL, const char* lpszPostData);

int CustomRequest(const QString& qsHTTPMethod, const QString& qsURL, const QString& qsPostData);

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 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 property, as well as through the Transfer event. The response headers can be retrieved through the TransferredHeaders property as well as through the Header 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 will be populated with the total number of entries contained within the feed. EntryIndex also will be set to 1, thus populating EntryProperties.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteEntry Method (OData Class)

This method deletes an entry within an OData service resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteEntry();

Unicode (Windows)
INT DeleteEntry();

int ipworks_odata_deleteentry(void* lpObj);

int DeleteEntry();

Remarks

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

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

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetEntryProperty Method (OData Class)

This method gets an OData entry property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryProperty(const char* lpszXPath);

Unicode (Windows)
LPWSTR GetEntryProperty(LPCWSTR lpszXPath);

char* ipworks_odata_getentryproperty(void* lpObj, const char* lpszXPath);

QString GetEntryProperty(const QString& qsXPath);

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

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: ODataControl.GetEntryProperty("entry[5]/content/properties/ID") ODataControl.GetEntryProperty("entry[5]/content/properties/ID@type")

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetSchema Method (OData Class)

This method retrieves the schema for a service.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSchema();

Unicode (Windows)
INT GetSchema();

int ipworks_odata_getschema(void* lpObj);

int GetSchema();

Remarks

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

Upon successful retrieval of the schema, set SchemaEntityIndex 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

HasXPath Method (OData Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
bool HasXPath(const char* lpszXPath);

Unicode (Windows)
INT HasXPath(LPCWSTR lpszXPath);

bool ipworks_odata_hasxpath(void* lpObj, const char* lpszXPath);

bool HasXPath(const QString& qsXPath);

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.

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

QueryService Method (OData Class)

This method queries an OData service using the specified parameters.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int QueryService();

Unicode (Windows)
INT QueryService();

int ipworks_odata_queryservice(void* lpObj);

int QueryService();

Remarks

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

The query results are delivered in the TransferredData property, as well as through the Transfer event. The response headers can be retrieved through the ParsedHeaders property as well as through the Header 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 will be populated with the total number of entries contained within the feed. EntryIndex will also be set to 1, thus populating EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties, and ResourcePath.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (OData Class)

This method resets all of properties of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworks_odata_reset(void* lpObj);

int Reset();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetEntryProperty Method (OData Class)

This method is used to set an OData entry property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetEntryProperty(const char* lpszXPath, const char* lpszValue);

Unicode (Windows)
INT SetEntryProperty(LPCWSTR lpszXPath, LPCWSTR lpszValue);

int ipworks_odata_setentryproperty(void* lpObj, const char* lpszXPath, const char* lpszValue);

int SetEntryProperty(const QString& qsXPath, const QString& qsValue);

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 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 along with the property specified to update the EntryProperty value.

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

property is any child of the property's element.

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

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetSchemaEntity Method (OData Class)

This method sets the schema entity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetSchemaEntity(const char* lpszName);

Unicode (Windows)
INT SetSchemaEntity(LPCWSTR lpszName);

int ipworks_odata_setschemaentity(void* lpObj, const char* lpszName);

int SetSchemaEntity(const QString& qsName);

Remarks

The class will set the schema entity to the Name specified. Once set, you can view the keys (via SchemaKeys), properties (via SchemaProperty), and navigation properties (via SchemaAssociation) contained within the specified entity.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetSchemaProperty Method (OData Class)

This method sets the schema property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetSchemaProperty(const char* lpszName);

Unicode (Windows)
INT SetSchemaProperty(LPCWSTR lpszName);

int ipworks_odata_setschemaproperty(void* lpObj, const char* lpszName);

int SetSchemaProperty(const QString& qsName);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetSchemaType Method (OData Class)

This method sets the schema type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetSchemaType(const char* lpszName);

Unicode (Windows)
INT SetSchemaType(LPCWSTR lpszName);

int ipworks_odata_setschematype(void* lpObj, const char* lpszName);

int SetSchemaType(const QString& qsName);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateEntry Method (OData Class)

This method updates an OData entry.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateEntry();

Unicode (Windows)
INT UpdateEntry();

int ipworks_odata_updateentry(void* lpObj);

int UpdateEntry();

Remarks

The class will update the OData entry specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath). 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 will then be set to zero (the first entry within the response), populating the EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties, and ResourcePath properties. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateProperty Method (OData Class)

This method updates an OData entry property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateProperty(const char* lpszXPath, const char* lpszValue);

Unicode (Windows)
INT UpdateProperty(LPCWSTR lpszXPath, LPCWSTR lpszValue);

int ipworks_odata_updateproperty(void* lpObj, const char* lpszXPath, const char* lpszValue);

int UpdateProperty(const QString& qsXPath, const QString& qsValue);

Remarks

The class will update the OData entry specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath). 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 will then be set to zero (the first entry within the response), populating the EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties, and ResourcePath. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Connected Event (OData Class)

Fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(ODataConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} ODataConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(ODataConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} ODataConnectedEventParams;

#define EID_ODATA_CONNECTED 1

virtual INT IPWORKS_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class ODataConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(ODataConnectedEventParams *e);

// Or, subclass OData and override this emitter function.
virtual int FireConnected(ODataConnectedEventParams *e) {...}

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 section for more information.

Disconnected Event (OData Class)

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(ODataDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} ODataDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(ODataDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} ODataDisconnectedEventParams;

#define EID_ODATA_DISCONNECTED 2

virtual INT IPWORKS_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class ODataDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(ODataDisconnectedEventParams *e);

// Or, subclass OData and override this emitter function.
virtual int FireDisconnected(ODataDisconnectedEventParams *e) {...}

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 section for more information.

EndTransfer Event (OData Class)

This event fires when a document finishes transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(ODataEndTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} ODataEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(ODataEndTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} ODataEndTransferEventParams;

#define EID_ODATA_ENDTRANSFER 3

virtual INT IPWORKS_CALL FireEndTransfer(INT &iDirection);

class ODataEndTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(ODataEndTransferEventParams *e);

// Or, subclass OData and override this emitter function.
virtual int FireEndTransfer(ODataEndTransferEventParams *e) {...}

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 (OData Class)

This event is fired once for each entity retrieved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEntity(ODataEntityEventParams *e);

typedef struct {
  const char *Name;
  int reserved;
} ODataEntityEventParams;


Unicode (Windows)
virtual INT FireEntity(ODataEntityEventParams *e);

typedef struct {
  LPCWSTR Name;
  INT reserved;
} ODataEntityEventParams;

#define EID_ODATA_ENTITY 4

virtual INT IPWORKS_CALL FireEntity(LPSTR &lpszName);

class ODataEntityEventParams {
public:
  const QString &Name();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Entity(ODataEntityEventParams *e);

// Or, subclass OData and override this emitter function.
virtual int FireEntity(ODataEntityEventParams *e) {...}

Remarks

The Entity event is fired once for each entity found when retrieving a service's schema (metadata document) through GetSchema.

Entry Event (OData Class)

This event is fired once for each entry retrieved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEntry(ODataEntryEventParams *e);

typedef struct {
  const char *Id;
  const char *Title;
  const char *Summary;
  const char *ETag;
  int reserved;
} ODataEntryEventParams;


Unicode (Windows)
virtual INT FireEntry(ODataEntryEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR Title;
  LPCWSTR Summary;
  LPCWSTR ETag;
  INT reserved;
} ODataEntryEventParams;

#define EID_ODATA_ENTRY 5

virtual INT IPWORKS_CALL FireEntry(LPSTR &lpszId, LPSTR &lpszTitle, LPSTR &lpszSummary, LPSTR &lpszETag);

class ODataEntryEventParams {
public:
  const QString &Id();

  const QString &Title();

  const QString &Summary();

  const QString &ETag();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Entry(ODataEntryEventParams *e);

// Or, subclass OData and override this emitter function.
virtual int FireEntry(ODataEntryEventParams *e) {...}

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 (OData Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(ODataErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} ODataErrorEventParams;


Unicode (Windows)
virtual INT FireError(ODataErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} ODataErrorEventParams;

#define EID_ODATA_ERROR 6

virtual INT IPWORKS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class ODataErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(ODataErrorEventParams *e);

// Or, subclass OData and override this emitter function.
virtual int FireError(ODataErrorEventParams *e) {...}

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

Header Event (OData Class)

Fired every time a header line comes in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHeader(ODataHeaderEventParams *e);

typedef struct {
  const char *Field;
  const char *Value;
  int reserved;
} ODataHeaderEventParams;


Unicode (Windows)
virtual INT FireHeader(ODataHeaderEventParams *e);

typedef struct {
  LPCWSTR Field;
  LPCWSTR Value;
  INT reserved;
} ODataHeaderEventParams;

#define EID_ODATA_HEADER 7

virtual INT IPWORKS_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);

class ODataHeaderEventParams {
public:
  const QString &Field();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Header(ODataHeaderEventParams *e);

// Or, subclass OData and override this emitter function.
virtual int FireHeader(ODataHeaderEventParams *e) {...}

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 (OData Class)

Fired once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(ODataLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} ODataLogEventParams;


Unicode (Windows)
virtual INT FireLog(ODataLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} ODataLogEventParams;

#define EID_ODATA_LOG 8

virtual INT IPWORKS_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class ODataLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(ODataLogEventParams *e);

// Or, subclass OData and override this emitter function.
virtual int FireLog(ODataLogEventParams *e) {...}

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

Property Event (OData Class)

This event is fired once for each property found within an entity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireProperty(ODataPropertyEventParams *e);

typedef struct {
  const char *Name;
  const char *TypeName;
  int Nullable;
  int reserved;
} ODataPropertyEventParams;


Unicode (Windows)
virtual INT FireProperty(ODataPropertyEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR TypeName;
  BOOL Nullable;
  INT reserved;
} ODataPropertyEventParams;

#define EID_ODATA_PROPERTY 9

virtual INT IPWORKS_CALL FireProperty(LPSTR &lpszName, LPSTR &lpszTypeName, BOOL &bNullable);

class ODataPropertyEventParams {
public:
  const QString &Name();

  const QString &TypeName();

  bool Nullable();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Property(ODataPropertyEventParams *e);

// Or, subclass OData and override this emitter function.
virtual int FireProperty(ODataPropertyEventParams *e) {...}

Remarks

The Property event is fired once for each property found within an entity after setting SchemaEntityIndex.

SetCookie Event (OData Class)

Fired for every cookie set by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSetCookie(ODataSetCookieEventParams *e);

typedef struct {
  const char *Name;
  const char *Value;
  const char *Expires;
  const char *Domain;
  const char *Path;
  int Secure;
  int reserved;
} ODataSetCookieEventParams;


Unicode (Windows)
virtual INT FireSetCookie(ODataSetCookieEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR Value;
  LPCWSTR Expires;
  LPCWSTR Domain;
  LPCWSTR Path;
  BOOL Secure;
  INT reserved;
} ODataSetCookieEventParams;

#define EID_ODATA_SETCOOKIE 10

virtual INT IPWORKS_CALL FireSetCookie(LPSTR &lpszName, LPSTR &lpszValue, LPSTR &lpszExpires, LPSTR &lpszDomain, LPSTR &lpszPath, BOOL &bSecure);

class ODataSetCookieEventParams {
public:
  const QString &Name();

  const QString &Value();

  const QString &Expires();

  const QString &Domain();

  const QString &Path();

  bool Secure();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SetCookie(ODataSetCookieEventParams *e);

// Or, subclass OData and override this emitter function.
virtual int FireSetCookie(ODataSetCookieEventParams *e) {...}

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 (OData Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(ODataSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} ODataSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(ODataSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} ODataSSLServerAuthenticationEventParams;

#define EID_ODATA_SSLSERVERAUTHENTICATION 11

virtual INT IPWORKS_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class ODataSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(ODataSSLServerAuthenticationEventParams *e);

// Or, subclass OData and override this emitter function.
virtual int FireSSLServerAuthentication(ODataSSLServerAuthenticationEventParams *e) {...}

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 (OData Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(ODataSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} ODataSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(ODataSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} ODataSSLStatusEventParams;

#define EID_ODATA_SSLSTATUS 12

virtual INT IPWORKS_CALL FireSSLStatus(LPSTR &lpszMessage);

class ODataSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(ODataSSLStatusEventParams *e);

// Or, subclass OData and override this emitter function.
virtual int FireSSLStatus(ODataSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (OData Class)

This event fires when a document starts transferring (after the headers).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartTransfer(ODataStartTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} ODataStartTransferEventParams;


Unicode (Windows)
virtual INT FireStartTransfer(ODataStartTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} ODataStartTransferEventParams;

#define EID_ODATA_STARTTRANSFER 13

virtual INT IPWORKS_CALL FireStartTransfer(INT &iDirection);

class ODataStartTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartTransfer(ODataStartTransferEventParams *e);

// Or, subclass OData and override this emitter function.
virtual int FireStartTransfer(ODataStartTransferEventParams *e) {...}

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 (OData Class)

Fired when the HTTP status line is received from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStatus(ODataStatusEventParams *e);

typedef struct {
  const char *HTTPVersion;
  int StatusCode;
  const char *Description;
  int reserved;
} ODataStatusEventParams;


Unicode (Windows)
virtual INT FireStatus(ODataStatusEventParams *e);

typedef struct {
  LPCWSTR HTTPVersion;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} ODataStatusEventParams;

#define EID_ODATA_STATUS 14

virtual INT IPWORKS_CALL FireStatus(LPSTR &lpszHTTPVersion, INT &iStatusCode, LPSTR &lpszDescription);

class ODataStatusEventParams {
public:
  const QString &HTTPVersion();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Status(ODataStatusEventParams *e);

// Or, subclass OData and override this emitter function.
virtual int FireStatus(ODataStatusEventParams *e) {...}

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 (OData Class)

Fired while a document transfers (delivers document).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(ODataTransferEventParams *e);

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int lenText;
  int reserved;
} ODataTransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(ODataTransferEventParams *e);

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCSTR Text;
  INT lenText;
  INT reserved;
} ODataTransferEventParams;

#define EID_ODATA_TRANSFER 15

virtual INT IPWORKS_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);

class ODataTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Transfer(ODataTransferEventParams *e);

// Or, subclass OData and override this emitter function.
virtual int FireTransfer(ODataTransferEventParams *e) {...}

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.

AtomChannel Type

The information about an Atom feed as it is received from the server.

Syntax

IPWorksAtomChannel (declared in ipworks.h)

Remarks

When an Atom feed is parsed by the component, each item is parsed into an AtomEntry type and other information about the feed are presented as AtomChannel.

Fields

Constructors

AtomChannel()

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksCertificate (declared in ipworks.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields