API browser of generalnotification451 COM module


/images/arrow_right.png IGeneralNotificationResponse::GetNextMessage method space
Retrieves the next notification message. VARIANT_FALSE is returned if the end of the message list is reached.

Note that the very first message is the most recent one, any following message is older by one message exchange hop. Therefore, the message iterator forms a serialized message historization.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralNotificationResponse/GetNextMessage
[JSON input data] pIGeneralNotificationResponse: longValue,    //interface address
[JSON result data] pbstrMessage:
pbstrFormOID:
pdMessageDate:
pbStatus:
"utf8StringValue",
"utf8StringValue",
"stringISODateValue",
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.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT GetNextMessage( BSTR
BSTR
DATE
VARIANT_BOOL
*pbstrMessage,
*pbstrFormOID,
*pdMessageDate,
*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.
space
/images/arrow_right.png Calling argument description
[out] BSTR *pbstrMessage The message on the current historization level.
[out] BSTR *pbstrFormOID An optional OID of a form.

This form OID must be ignored as it is just a historicized one.

[out] DATE *pdMessageDate The date when the message was generated.
[out,retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached
space