ISCardCmd::get_Apdu method

[The get_Apdu 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_Apdu method retrieves the raw application protocol data unit (APDU).

Syntax

HRESULT get_Apdu(
  [out] LPBYTEBUFFER *ppApdu
);

Parameters

ppApdu [out]

Pointer to the byte buffer mapped through an IStream object that contains the APDU message on return.

Return value

The method returns one of the following possible values.

Remarks

To copy the APDU from an IByteBuffer (IStream) object into the APDU wrapped in this interface object, call put_Apdu.

To determine the length of the APDU, call get_ApduLength.

For a list of all the methods provided by the ISCardCmd 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 information about smart card error codes, see Smart Card Return Values.

Examples

The following example shows how to retrieve the raw application protocol data unit (APDU). The example assumes that pISCardCmd is a valid pointer to the ISCardCmd interface, and that pIByteApdu is a valid pointer to an instance of the IByteBuffer interface.

HRESULT    hr;

hr = pISCardCmd->get_Apdu(&pIByteApdu);
if (FAILED(hr)) 
{
    printf("Failed get_Apdu.\n");
    // Take other error handling action as needed.
}

Requirements

See also

get_ApduLength

ISCardCmd

put_Apdu