QueryService Method

Queries an OData service using the specified parameters.

Syntax

ANSI (Cross Platform)
int QueryService();

Unicode (Windows)
INT QueryService();
- (void)queryService;
#define MID_ODATA_QUERYSERVICE 9

IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_OData_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

Queries an OData feed specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath) using the query options specified in the Query*** properties and OtherQueryOptions. To fetch 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 via the ParsedHeaders property as well as through the Header event.

The class will then 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.)

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 C++ Edition - Version 20.0 [Build 8307]