The ATL COM module generalNotification is a structured
message exchange protocol between to healthcare partners
message exchange protocol between to healthcare partners
API browser of generalnotification451 COM module
IGeneralNotificationResponse::GetFirstInstruction method | |||
---|---|---|---|
Retrieves the first instruction as token/value pair. VARIANT_FALSE is returned if the end of the instruction list is reached.
Note that these instructions are defined purely between sender and receiver regarding the semantic meaning. The infoset is just the transport container. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralNotificationResponse/GetFirstInstruction | ||
[JSON input data] | pIGeneralNotificationResponse: | longValue, //interface address |
|
[JSON result data] | plGroupNumber: pbstrToken: pbstrValue: pbStatus: |
longValue, "utf8StringValue", "utf8StringValue", booleanValue |
|
[HTTP result status] | 200 | Return status 200 signals a successful method call | |
204 | Return status 204 (noContent) signals that the end of an iteration is reached | ||
>= 400 | Return status >= 400 signals an unsuccessful function call. The returned JSON{errorCode: code, errorText:"text"} supplies the error message the same as GetAbortInfo() would do. | ||
C/C++ calling syntax | |||
HRESULT GetFirstInstruction( | long
BSTR BSTR VARIANT_BOOL |
*plGroupNumber,
*pbstrToken, *pbstrValue, *pbStatus); |
|
[C/C++ return value] | S_OK | This value is returned if the function call was successful. | |
S_FALSE | This value is returned if the end of an iteration is reached | ||
E_name | This value is returned if the function call was unsuccessful and an error exception was generated. Note that if you are using SmartPointers an exception is thrown under these conditions. | ||
Calling argument description | |||
[out] long | *plGroupNumber | The lGroupNumber allows to further group the instruction set by a group numbering scheme.
Note that the instructions are returned in the same sequence as the input was done. Therefore, the grouping into equal instructions must be done outside the COM module. |
|
[out] BSTR | *pbstrToken | The token part of the token/value formatted instruction | |
[out] BSTR | *pbstrValue | The value part of the token/value formatted instruction | |
[out,retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached | |