API browser of generalnotification440 COM module


/images/arrow_right.png IGeneralNotificationResponse::GetFirstMessage method
Retrieves the first 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 messages are older by one message exchange. Therefore the message iterator forms a serialized message historization.

space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT GetFirstMessage( BSTR
BSTR
DATE
BSTR
VARIANT_BOOL
*pbstrMessage,
*pbstrFormOID,
*pMessageDate,
*pbstrPDFFile,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[out] BSTR *pbstrMessage The most recent message.
[out] BSTR *pbstrFormOID An optional OID of a form.

If this form OID is set then this signals to start a form process using the GeneralFormRequestManager430 COM module and thereby generating a generalFormRequest_430.xsd based XML infoset. The sender, receiver, and reference object must be copied and the given form OID used as PDF template. To ease and simplify that process the current generalNotification_430 XML infoset can be loaded directly info the GeneralFormRequestManager430 COM module

[out] DATE *pMessageDate The date when the most recent message was generated.
[out] BSTR *pbstrPDFFile An optional PDF document attached to the notification message.

If the variable is not empty than the full path to the PDF is replied. The PDF must be copied away before the COM module is closed otherwise the PDF document is deleted.

[out, retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached
 
/images/arrow_right.png C/C++ return value
S_OK This value is returned if the function call was successful or if the return value of a boolean method signalling a true value. In this case the VARIANT_BOOL is set to VARIANT_TRUE.
S_FALSE This is the return value of a boolean method signalling a false return value. In this case the VARIANT_BOOL is set to VARIANT_FALSE.
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.