API browser of generalnotification451 COM module


/images/arrow_right.png IGeneralNotificationRequest::SetMessage method
Sets the primary message parameters of a new message thread as opposed to the SetReply method used when replying to an existing message thread.

Note that the PDF form OID mechanism is a signal for the receiver to start a form process. In the Sumex1 environment the form OID is one from the medforms.ch space.

space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT SetMessage( BSTR
BSTR
VARIANT_BOOL
bstrMessage,
bstrFormOID,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[in] BSTR bstrMessage The required message.
[in] BSTR bstrFormOID An optional form OID.

The definition of such a form OID signals the receiver to start a form process using the given OID as form template and using the reference object and the sender, receiver data as additional input. The resulting XML infoset of type generalFormRequest_430 must then be transmitted to receiver (the mirrored sender of this XML infoset).

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