ISCardISO7816::WriteRecord method

Стаття
01/07/2021

[The WriteRecord 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 WriteRecord method constructs an application protocol data unit (APDU) command that initiates one of the following operations:

The write once of a record.
The logical OR of the data bytes of a record already present in the card with the data bytes of the record given in the command APDU.
The logical AND of the data bytes of a record already present in the card with the data bytes of the record given in the command APDU.

When no indication is given in the data coding byte, the logical OR behavior applies.

Note

When using current record addressing, the command sets the record pointer on the successfully updated record.

Syntax

HRESULT WriteRecord(
  [in]      BYTE         byRecordId,
  [in]      BYTE         byRefCtrl,
  [in]      LPBYTEBUFFER pData,
  [in, out] LPSCARDCMD   *ppCmd
);

Parameters

byRecordId [in]

Record identification. This is the 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 written.

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
S_OK	Operation completed successfully.
E_INVALIDARG	Invalid parameter.
E_POINTER	A bad pointer was passed in.
E_OUTOFMEMORY	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 encapsulated 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 it 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.

If P2=xxxxx011 and the elementary file is cyclic file, this command has the same behavior a command constructed using AppendRecord.

Elementary files without a record structure cannot be written to. The constructed 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	Scardssp.h
Type library	Scardsrv.tlb
DLL	Scardssp.dll
IID	IID_ISCardISO7816 is defined as 53B6AA68-3F56-11D0-916B-00AA00C18068

Поділитися через