API browser of generalnotification451 COM module


/images/arrow_right.png IGeneralNotificationRequest::AddInstruction method space
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 although that even if the notification deals only with such instructions, a meaningful message is still required as forced by the underlying XSD schema.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralNotificationRequest/AddInstruction
[JSON input data] pIGeneralNotificationRequest:
lGroupNumber:
bstrToken:
bstrValue:
longValue,    //interface address
longValue,
"utf8StringValue",
"utf8StringValue"
[JSON result data] pbStatus: booleanValue
 
[HTTP result status] 200 Return status 200 signals a successful method call
204 Return status 204 (noContent) signals that the end of an iteration is reached
>= 400 Return status >= 400 signals an unsuccessful function call. The returned JSON{errorCode: code, errorText:"text"} supplies the error message the same as GetAbortInfo() would do.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT AddInstruction( long
BSTR
BSTR
VARIANT_BOOL
lGroupNumber,
bstrToken,
bstrValue,
*pbStatus);
[C/C++ return value] S_OK This value is returned if the function call was successful.
S_FALSE This value is returned if the end of an iteration is reached
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.
space
/images/arrow_right.png 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 a 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.
space