API browser of generalnotification440 COM module


/images/arrow_right.png IGeneralNotificationResponse::GetNotification method
Retrieves the main notification object reference parameters.

The dependent object references (if supplied in the request) form a object reference chain with the notification as topmost object reference. The page "object reference" provides an in-depth description of the concepts of "object reference", "object reference chain", and "topmost object reference".

space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT GetNotification( BSTR
DATE
long
VARIANT_BOOL
*pbstrNotificationID,
*pdNotificationDate,
*plNotificationTimestamp,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[out] BSTR *pbstrNotificationID The notification ID is the main software's identification of the notification.

This is one of 3 identifiers that form the notification object reference.

[out] DATE *pdNotificationDate The notification date is the main software's date of the notification.

This is one of 3 identifiers that form the notification object reference.

[out] long *plNotificationTimestamp This is a UNIX timestamp defined at the moment of the notification's infoset generation.

This is one of 3 identifiers that form the notification object reference.

[out, retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE then an error occurred and GetAbortInfo should be called to retrieve the error string.
 
/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.