Sumex1.net/generalNotification/C++ API: IGeneralNotificationRequest::SetMessage method

API browser of generalnotification440 COM module

IGeneralNotificationRequest::SetMessage method
Sets the primary message that starts the notification thread. Note that the 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.

C/C++ calling syntax
HRESULT SetMessage(	BSTR BSTR BSTR VARIANT_BOOL	bstrMessage, bstrFormOID, bstrPDFFile, *pbStatus);

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).
[in] BSTR	bstrPDFFile	An optional PDF document that can be attached. The PDF is included inline coded as a Base64 stream. Note that the PDF document transferred to the recipient is thereafter not included in the reply message stream anymore.
[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.

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.