The statusResponse ATL COM module defines/returns
the status of a prior queried reference object
API browser of statusResponse430 COM module


/images/arrow_right.png IStatusResponse::GetFirstQueryObject method
Retrieves the first "response" object which is the request object enhanced with a status qualification.

VARIANT_FALSE is returned if the end of the object list is reached

space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT GetFirstQueryObject( ObjectType
BSTR
DATE
long
StatusType
VARIANT_BOOL 		*peObjectType,
*pbstrRequestID,
*pdRequestDate,
*plRequestTimestamp,
*peStatusType,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[out] ObjectType *peObjectType Defines the type of the object request
[out] BSTR *pbstrRequestID The request ID is the identification of a request of that type (e.g. the invoice or reminder identification).
This is one of 3 identifiers that form an object reference. The request ID is always defined by the sender of the original request since the object reference from the request is mirrored in the response.
[out] DATE *pdRequestDate The request date is the date of a request of that type (e.g. the invoice or reminder date).
This is one of 3 identifiers that form an object reference. The request date is always defined by the sender of the original request since the object reference from the request is mirrored in the response.
[out] long *plRequestTimestamp The request timestamp is a UNIX timestamp defined at the moment of the XML infoset generation.
This is one of 3 identifiers that form an object reference. The request timestamp is always defined by the sender of the original request since the object reference from the request is mirrored in the response.
[out] StatusType *peStatusType The status of the queried request object valid encoded by a terminal set of status tokens.
[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.