API browser of generalnotification451 COM module


/images/arrow_right.png IGeneralNotificationRequest::SetRefObject method
Sets the optional depended object reference of type credit, invoice, reminder, MCD, or form for which this notification thread is actually started.

This reference object forms an 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".

Note that the dependent object reference as well as the patient data must stem from that dependent request infoset!

space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT SetRefObject( ObjectType
BSTR
DATE
long
VARIANT_BOOL
eRefObjectType,
bstrRequestID,
dRequestDate,
lRequestTimestamp,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[in] ObjectType eRefObjectType The type of the depended object reference.
[in] BSTR bstrRequestID The request ID is the main software's identification of the dependent reference object.

This is one of 3 identifiers that constitute this object reference.

[in] DATE dRequestDate The request date is the main software's date of the dependent reference object.

This is one of 3 identifiers that constitute this object reference.

[in] long lRequestTimestamp This is a UNIX timestamp defined at the moment of the dependent reference object's infoset generation.

This is one of 3 identifiers that constitute this 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.