ISCardCmd::get_ReplyStatus method

[The get_ReplyStatus method is available for use in the operating systems specified in the Requirements section. It is not available for use in Windows Server 2003 with Service Pack 1 (SP1) and later, Windows Vista, Windows Server 2008, and subsequent versions of the operating system. The Smart Card Modules provide similar functionality.]

The get_ReplyStatus method retrieves the reply APDU's message status word.

Syntax

HRESULT get_ReplyStatus(
  [out] LPWORD pwStatus
);

Parameters

pwStatus [out]

Pointer to the word that is the status on return.

Return value

The method returns one of the following possible values.

Return code Description
S_OK
Operation completed successfully.
E_INVALIDARG
The pwStatus parameter is not valid.
E_POINTER
A bad pointer was passed in pwStatus.
E_OUTOFMEMORY
Out of memory.

 

Remarks

To set the reply APDU's message status word, call put_ReplyStatus.

For a list of all the methods provided by this interface, see ISCardCmd.

In addition to the COM error codes listed above, this interface may return a smart card error code if a smart card function was called to complete the request. For more information, see Smart Card Return Values.

Examples

The following example shows how to retrieve the message status word of the reply APDU. The example assumes that pISCardCmd is a valid pointer to an instance of the ISCardCmd interface.

WORD    wReplyStatus;
HRESULT hr;

// Get reply status.
hr = pISCardCmd->get_ReplyStatus(&wReplyStatus);
if (FAILED(hr))
{
  printf("Failed get_ReplyStatus\n");
  // Take other error handling action as needed.
}
else
{
  if (wReplyStatus != 0x9000)
  {
    printf("APDU failed - Error [0x%x]\n", wReplyStatus);
    // Take other error handling action as needed.
  }
}

Requirements

Requirement Value
Minimum supported client
Windows XP [desktop apps only]
Minimum supported server
Windows Server 2003 [desktop apps only]
End of client support
Windows XP
End of server support
Windows Server 2003
Header
Scarddat.h
Type library
Scarddat.tlb
DLL
Scardssp.dll
IID
IID_ISCardCmd is defined as D5778AE3-43DE-11D0-9171-00AA00C18068

See also

ISCardCmd

put_ReplyStatus