Share via


PHReadPIN (Windows Embedded CE 6.0)

1/6/2010

This function retrieves the encrypted PIN and decrypts it for the caller.

Syntax

HRESULT  PHReadPIN(
WCHAR*  pPinBuffer,
int BufferLength
);

Parameters

  • pPinBuffer
    [out] The encrypted PIN in a string buffer. The buffer must be passed in and of length, BufferLength.
  • BufferLength
    [out] Length of the string buffer. It must be non-zero.

Return Value

The function returns a variety of HRESULT values, depending on whether the call succeeded or failed. The following table shows additional possible return values.

Value Description

E_FAIL

Failure. Either the string pointer or the length were NULL. Also, something may have gone wrong with the retrieval or decryption of the PIN from the Registry.

S_OK

Success.

E_INVALIDARG

The function failed to open the specified registry key. The path may be invalid.

E_OUTOFMEMORY

There was insufficient memory to perform the operation.

Remarks

Note

This documentation applies to functionality implemented in sample code for PhCommon. For more information, see PhCommon Reference.

Requirements

Header settingsapi.hpp
Library PhCommon.dll
Windows Embedded CE Windows Embedded CE 6.0 and later

See Also

Reference

PhCommon Authentication APIs
PhCommon Reference