ISCardISO7816::UpdateRecord method
[The UpdateRecord 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 UpdateRecord method constructs an application protocol data unit (APDU) command that updates a specific record with the bits given in the APDU command.
Note
When using current record addressing, the command sets the record pointer on the successfully updated record.
Syntax
HRESULT UpdateRecord(
[in] BYTE byRecordId,
[in] BYTE byRefCtrl,
[in] LPBYTEBUFFER pData,
[in, out] LPSCARDCMD *ppCmd
);
Parameters
-
byRecordId [in]
-
P1 value:
P1 = 00 designates the current record
P1 != '00' is the number of the specified record
-
byRefCtrl [in]
-
Coding of the reference control P2:
Value Meaning - Current EF
Bit position: 00000---
Currently selected EF.- Short EF ID
Bit position: xxxxx---
Short EF identifier.- First Record
Bit position: -----000 - Last Record
Bit position: -----001 - Next Record
Bit position: -----010 - Previous Record
Bit position: -----011 - Record # in P1
Bit position: -----100 -
pData [in]
-
Pointer to the record to be updated.
-
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 processed.
When the command contains a valid short elementary identifier, it sets the file as current elementary file. If another elementary file is currently selected at the time of issuing this command, this command may be processed without identification of the currently selected file.
If the constructed command applies to a linear-fixed or cyclic-structured elementary file, it will abort if the record length is different from the length of the existing record.
If the command applies to a linear-variable structured elementary file, it may be carried out when the record length is different from the length of the existing record.
The "previous" option of the command (P2=xxxxx011), applied to a cyclic file, has the same behavior as a command constructed by AppendRecord.
Elementary files without a record structure cannot be read. The constructed command aborts if applied to an elementary file without 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