LAPLockoutUser
A version of this page is also available for
4/8/2010
This optional function is called when the device needs to block an user from continuing for a set period of time. This is a LAP-exported function.
Syntax
BOOL LAPLockoutUser(
HWND hwnd,
LPCWSTR pwszAEDisplayText,
DWORD cSecondsToLockout
);
Parameters
- hwnd
[in] Handle to the parent window. This value may be NULL.
- pwszAEDisplayText
[in] Pointer to the text for the LAP to display. The value will be the same pwszAEDisplayText as passed to VerifyUser (LAP).
- cSecondsToLockout
[in] Amount of time, in seconds, to block the user from continuing.
Return Value
Returns TRUE if the user was successfully locked out for the duration specified in cSecondsToLockout.
Returns FALSE if the user cancels during the lockout period. If the return value is FALSE, the LASS knows that lockout was not completed successfully and the lockout will be run again the next time the user tries authenticate. To provide more details about why the function failed, use SetLastError.
Remarks
This function is used with exponential backoff. The simplest implementation of this API is to disable use of device features (except for emergency calling) for cSecondsToLockout seconds. For a more robust implementation, the UI could display a dialog informing the user they have cSecondsToLockout seconds before they can continue.
Note
It is very important for users to be able to dial emergency numbers while locked out of the device. Any implementation of this function needs to provision for such a scenario.
Note
This function is called by the LASS, not the application. Therefore, no link library is exposed. .
Requirements
| Header | lap.h |
| Windows Mobile | Windows Mobile 6 Classic and later, Windows Mobile 6 Professional and later, Windows Mobile 6 Standard 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. |