Edit

ISCardFileAccess::GetFileCapabilities method

  • Article

[The GetFileCapabilities 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 GetFileCapabilities method retrieves a list of file capabilities from the current file.

Syntax

HRESULT GetFileCapabilities(
  [in, out] LPTLV_TABLE *ppProperties,
  [in, out] LONG        *plProperties,
  [in]      SCARD_FLAGS Flags
);

Parameters

ppProperties [in, out]

Pointer to TLV (tag, length, value) structures. On input, this parameter indicates the files for which to get properties; on output, this parameter contains the properties. The following example is a definition of the TLV structure.

#include <windows.h>

typedef struct
{
  DWORD  Tag;
  DWORD  Length;
  BYTE[]  Value;
  BOOL  Valid;
} TLV;

For more information on TLV structures, see https://pcscworkgroup.com/.

plProperties [in, out]

Pointer to the number of TLV entries in ppProperties.

Flags [in]

Specifies whether secure messaging has to be used and data preallocated.

SC_FL_SECURE_MESSAGING

SC_FL_PREALLOCATED

Return value

The method returns one of the following possible values.

Return code Description
S_OK
 Operation was completed successfully.
E_INVALIDARG
 Invalid parameter.
E_POINTER
 A bad pointer was passed in.
E_OUTOFMEMORY
 Out of memory.

 

Remarks

For a list of all the methods defined by this interface, see ISCardFileAccess.

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

See also

ISCardFileAccess