ISCardISO7816::EraseBinary

The EraseBinary method constructs an APDU command that sequentially sets part of the content of an elementary file to its logical erased state, starting from a given offset.

HRESULT EraseBinary(
  BYTE byP1,
  BYTE byP2,
  LPBYTEBUFFER pData,
  LPSCARDCMD *ppCmd
);

Parameters

byP1, byP2 [in]
RFU position.
If… Then…
b8=1 in P1 b7 and b6 of P1 are set to 0 (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.
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, defaultvalue(NULL)]
Pointer to the data that specifies the erase range; 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 via the ppCmd pointer.

Return Values

The possible return values are the following:

Value Meaning
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.

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 the ISCardISO7816 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 information on smart card error codes, see Error Codes.

QuickInfo

  Windows NT: Use version 4.0 SP3 and later.
  Windows: Use Windows 95 OSR2.1.
  Windows CE: Unsupported.
  Header: Declared in scardsrv.h.
  Import Library: scardsrv.tlb.

See Also

ISCardISO7816, ReadBinary, UpdateBinary, WriteBinary