ISCardISO7816::ReadRecord method
[The ReadRecord 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 ReadRecord method constructs an application protocol data unit (APDU) command that reads either the contents of the specified records or the beginning part of one record of an elementary file.
Syntax
HRESULT ReadRecord(
[in] BYTE byRecordId,
[in] BYTE byRefCtrl,
[in] LONG lBytesToRead,
[in, out] LPSCARDCMD *ppCmd
);
Parameters
-
byRecordId [in]
-
Record number or ID of the first record to be read (00 indicates the current record).
-
byRefCtrl [in]
-
Coding of the reference control.
Value Meaning - Current EF
Bit position: 00000---
Currently selected EF.- Short EF ID
Bit position: xxxxx---
Short EF identifier.- RFU
Bit position: 11111--- - Record #
Bit position: -----1xx
Usage of record number in P1.- Read Record
Bit position: -----100
Read record P1.- Up to Last
Bit position: -----101
Read all records from P1 up to the last.- Up to P1
Bit position: -----110
Read all records from the last up to P1.- RFU
Bit position: -----111 - Record ID
Bit position: -----0xx
Usage of record number in P1.- First Occur
Bit position: -----000
Read first occurrence.- Last Occur
Bit position: -----001
Read last occurrence.- Next Occur
Bit position: -----010
Read next occurrence.- Previous
Bit position: -----011
Read previous occurrence.- Secret
Bit position: ---xxxxx -
lBytesToRead [in]
-
Number of bytes to read from the transparent EF.
If the Le field contains only zeros, then depending on b3b2b1 of P2 and within the limit of 256 for short length or 65536 for extended length, the command should read completely either the single requested record or the requested sequence of records.
-
ppCmd [in, out]
-
On input, a pointer to an ISCardCmd interface object or NULL.
On return, it is filled with the APDU command constructed by this operation. If ppCmd was set to NULL, a smart card ISCardCmd object is internally created and returned via the ppCmd pointer.
Return value
The method returns one of the following possible values.
| Return code | Description |
|---|---|
|
Operation completed successfully. |
|
Invalid parameter. |
|
A bad pointer was passed in. |
|
Out of memory. |
Remarks
The encapsulated command can only be performed if the security status of the smart card satisfies the security attributes of the elementary file being read.
If another elementary file is currently selected at the time of issuing this command, it may be processed without identification of the currently selected file.
When the command contains a valid short elementary identifier, it sets the file as current elementary file.
Elementary files without a record structure cannot be read. The encapsulated command aborts if applied to an elementary file without a record structure.
For a list of all the methods provided by this interface, see ISCardISO7816.
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.
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 |
|
| Type library |
|
| DLL |
|
| IID |
IID_ISCardISO7816 is defined as 53B6AA68-3F56-11D0-916B-00AA00C18068 |
See also