API browser of generalnotification440 COM module


/images/arrow_right.png IGeneralNotificationResponse::GetFirstInstruction method
Retrieves the first instruction as token/value pair. VARIANT_FALSE is returned if the end of the instruction list is reached.

Note that these instructions are defined purely between sender and receiver regarding the semantic meaning. The infoset is just the transport container.

space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT GetFirstInstruction( long
BSTR
BSTR
VARIANT_BOOL
*plGroupNumber,
*pbstrToken,
*pbstrValue,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[out] long *plGroupNumber The lGroupNumber allows to further group the instruction set by a group numbering scheme.

Note that the instructions are returned in the same sequence as the input was done. Therefore, the grouping into equal instructions must be done outside the COM module.

[out] BSTR *pbstrToken The token part of the token/value formatted instruction
[out] BSTR *pbstrValue The value part of the token/value formatted instruction
[out, retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached
 
/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.