[The GetChallenge 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 GetChallenge method constructs an application protocol data unit (APDU) command that issue a challenge (for example, a random number) for use in a security-related procedure.
Syntax
HRESULT GetChallenge(
[in] LONG lBytesExpected,
[in, out] LPSCARDCMD *ppCmd
);
Parameters
lBytesExpected [in]
Maximum length of the expected response.
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 challenge is valid at least for the next command.
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 |
See also
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
