API browser of generalnotification451 COM module


/images/arrow_right.png IGeneralNotificationRequest::SetNotification method
Sets the main notification object reference.

The dependent object references 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 SetNotification( BSTR
DATE
long
VARIANT_BOOL
bstrNotificationID,
dNotificationDate,
lNotificationTimestamp,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[in] BSTR bstrNotificationID The notification ID is the main software's ID of the notification.

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

[in] DATE dNotificationDate The notification date is the main software's date of the notification.

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

[in] long lNotificationTimestamp This is a UNIX timestamp defined at the moment of the notification's infoset generation. Set this variable 0 to indicate the generation of a new notification object reference. The IGeneralNotificationManager::GetXML method will return the timestamp that must be used from that point on as 3rd parameter of the object reference.

This is one of 3 identifiers that constitute the notification object reference. The timestamp will be generated once for a certain notification object reference and thereafter the timestamp is always referenced

[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.