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

API browser of generalnotification440 COM module

IGeneralNotificationRequest::AddInstruction method
Adds an automation instruction to the list of instructions. The instruction is formatted as a token/value pair Note that these instructions are defined purely between sender and receiver regarding the semantic meaning. The infoset is just the transport container. Note also that even if the notification deals with such instructions, a meaningful message is still required as forced by the underlying XSD schema.

C/C++ calling syntax
HRESULT AddInstruction(	long BSTR BSTR VARIANT_BOOL	lGroupNumber, bstrToken, bstrValue, *pbStatus);

Calling argument description
[in] long	lGroupNumber	The lGroupNumber allows to further group the instruction set by a group numbering scheme.
[in] BSTR	bstrToken	The token part of the token/value formatted instruction
[in] BSTR	bstrValue	The value part of the token/value formatted instruction
[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.