ISCardISO7816::EraseBinary method
[The EraseBinary 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 EraseBinary method constructs an application protocol data unit (APDU) command that sequentially sets part of the content of an elementary file to its logical erased state, starting from a given offset.
Syntax
HRESULT EraseBinary(
[in] BYTE byP1,
[in] BYTE byP2,
[in] LPBYTEBUFFER pData,
[in, out] LPSCARDCMD *ppCmd
);
Parameters
-
byP1 [in]
-
RFU position.
If b8=1 in P1, then b7 and b6 of P1 are set to zero (RFU bits), b5 to b1 of P1 are a short EF identifier and P2 is the offset of the first byte to be erased (in data units) from the beginning of the file.
If b8=0 in P1, then P1 || P2 is the offset of the first byte to be erased (in data units) from the beginning of the file.
If the data field is present, it codes the offset of the first data unit not to be erased. This offset shall be higher than the one coded in P1-P2. When the data field is empty, the command erases up to the end of the file.
-
byP2 [in]
-
RFU position.
If b8=1 in P1, then b7 and b6 of P1 are set to zero (RFU bits), b5 to b1 of P1 are a short EF identifier and P2 is the offset of the first byte to be erased (in data units) from the beginning of the file.
If b8=0 in P1, then P1 || P2 is the offset of the first byte to be erased (in data units) from the beginning of the file.
If the data field is present, it codes the offset of the first data unit not to be erased. This offset shall be higher than the one coded in P1-P2. When the data field is empty, the command erases up to the end of the file.
-
pData [in]
-
A pointer to the data that specifies the erase range. This parameter may be NULL.
-
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 by using the ppCmd pointer.
Return value
The method returns one of the following possible values.
| Return code | Description |
|---|---|
|
The operation completed successfully. |
|
A parameter that is not valid was passed. |
|
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.
Elementary files without a transparent structure cannot be erased. The encapsulated command aborts if applied to an elementary file without a transparent 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