ISCardCmd::get_ApduReply method

Article
01/07/2021

[The get_ApduReply 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_ApduReply method retrieves the reply APDU, placing it in a specific byte buffer. The reply may be NULL if no transaction has been performed on the command APDU.

Syntax

HRESULT get_ApduReply(
  [out] LPBYTEBUFFER *ppReplyApdu
);

Parameters

ppReplyApdu [out]: Pointer to the byte buffer (mapped through an IStream object) that contains the APDU reply message on return.

Return value

The method returns one of the following possible values.

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

Remarks

To determine the length of the APDU reply, call get_ApduReplyLength.

To set a new reply APDU, call put_ApduReply.

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 reply data. The example assumes that lLe is a variable of type LONG whose value was set by a previous call to the ISCardCmd::get_ApduReplyLength method, that pIByteReply is a valid pointer to an instance of the IByteBuffer interface, and that pISCardCmd is a valid pointer to an instance of the ISCardCmd interface.

HRESULT      hr;

if (lLe > 0)
{
    // Get reply data if available.
    hr = pISCardCmd->get_ApduReply(&pIByteReply);
    if (FAILED(hr)) 
    {
        printf("Failed ISCardCmd::get_ApduReply.\n");
        // Take other error handling action as needed.
    }
    else
    {
        BYTE byReplyBytes[256];
        LONG lBytesRead;

        hr = pIByteReply->Read(byReplyBytes, lLe, &lBytesRead);
        if (FAILED(hr))
        {
            printf("Failed IByteBuffer::Read.\n");
            // Take other error handling action as needed.
        }
        // Use the bytes in byReplyBytes 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

Share via