VerifyUser (LAP)

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function performs the user verification. It has basically the same parameters as the application-called VerifyUser function. This is a LAP-exported function.

Syntax

BOOL VerifyUser(
  const GUID* AEKey,
  LPCWSTR pwszAEDisplayText,
  HWND hWndParent,
  DWORD dwOptions,
  PVOID pExtended
);

Parameters

  • AEKey
    [in] Pointer to the authentication event identifier. The identifier corresponds to the type of authentication required.
  • pwszAEDisplayText
    [in] Pointer to the text for the LAP to display. This will be the same psszAEDisplayText as passed to LAPLockoutUser.
  • hWndParent
    [in] Handle to the parent window.

  • dwOptions
    [in] A bitmask of options. The following table shows the possible values.

    Value Description

    VU_NO_UI

    When this flag is set, LAP cannot display UI or block on calls to VerifyUser. When using this value, the function will return TRUE only if the user can be verified without displaying the UI. Otherwise, it will return FALSE.

    VU_HANDLE_MASTER_KEY

    When this flag is set, it indicates to handle master key encryption and decryption if master key encryption and decryption are supported.

    VU_UNTIL_SUCCESS

    When this flag is set, the LAP VerifyUser entry-point function will be called until the user cancels or until the call succeeds.

    Notice that there may be multiple calls to VerifyUser during the time between the call to VerifyUserStart and the call to VerifyUserStop. This enables you to cache state during the time between the call to VerifyUserStart and the call to VerifyUserStop.
  • pExtended
    Reserved. Must be set to NULL.

Return Value

Returns TRUE if the user is verified, and FALSE otherwise. To provide more details about why the function failed, use SetLastError.

Remarks

When an application calls VerifyUser with the VU_UNTIL_SUCCESS flag set, the call can result in several calls into the LAP. To prevent UI flash, the LASS will call VerifyUserStart before any VerifyUser (LAP) calls are made. After all VerifyUser calls have been made, the LASS will call VerifyUserStop.

When the application calls VerifyUser, the LAP displays its verification dialog. It is possible for a second application to run and display its UI on top of the LAP verification UI in the z order. If the second application then calls VerifyUser, it will block. To prevent this UI blockage, the LASS will call VerifyUserToTop to request the LAP to bring its UI to the top of the z order.

Note

This function is called by the LASS, not the application. Therefore, no link library is exposed.

Note

The PromptForPasswd function is deprecated. Use the VerifyUser function instead.

Requirements

Header lap.h
Windows Embedded CE Windows CE 5.0 and later
Windows Mobile Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later
Note This function is called by the LASS, not the application. Therefore, no link library is exposed. For more information see Creating a LAP.

See Also

Reference

LAP-Exported Functions
VerifyUser
VerifyUserStart
VerifyUserStop
VerifyUserToTop