/** @file\r
- UEFI 2.2 User Credential Protocol definition.\r
+ UEFI 2.2 User Credential Protocol definition.It has been removed from UEFI 2.3.1 and replaced\r
+ by EFI_USER_CREDENTIAL2_PROTOCOL.\r
\r
Attached to a device handle, this protocol identifies a single means of identifying the user.\r
\r
- Copyright (c) 2009 - 2010, Intel Corporation \r
- All rights reserved. This program and the accompanying materials \r
+ Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
+ This program and the accompanying materials \r
are licensed and made available under the terms and conditions of the BSD License \r
which accompanies this distribution. The full text of the license may be found at \r
http://opensource.org/licenses/bsd-license.php \r
/**\r
Enroll a user on a credential provider.\r
\r
- This function enrolls a user profile using this credential provider. If a user profile is successfully \r
- enrolled, it calls the User Manager Protocol function Notify() to notify the user manager driver \r
- that credential information has changed.\r
+ This function enrolls and deletes a user profile using this credential provider. If a user profile\r
+ is successfully enrolled, it calls the User Manager Protocol function Notify() to notify the user \r
+ manager driver that credential information has changed. If an enrolled user does exist, delete the \r
+ user on the credential provider.\r
\r
@param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
@param[in] User The user profile to enroll.\r
the user credential provider does not require a form to identify the user, then this function should \r
return EFI_NOT_FOUND.\r
\r
- @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
- @param[out] Hii On return, holds the HII database handle.\r
- @param[out] FormSetId On return, holds the identifier of the form set which contains\r
- the form used during user identification.\r
- @param[out] FormId On return, holds the identifier of the form used during user identification.\r
+ @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
+ @param[out] Hii On return, holds the HII database handle.\r
+ @param[out] FormSetId On return, holds the identifier of the form set which contains\r
+ the form used during user identification.\r
+ @param[out] FormId On return, holds the identifier of the form used during user \r
+ identification.\r
\r
- @retval EFI_SUCCESS Form returned successfully.\r
- @retval EFI_NOT_FOUND Form not returned.\r
+ @retval EFI_SUCCESS Form returned successfully.\r
+ @retval EFI_NOT_FOUND Form not returned.\r
+ @retval EFI_INVALID_PARAMETER Hii is NULL or FormSetId is NULL or FormId is NULL.\r
**/\r
typedef\r
EFI_STATUS\r
This optional function returns a bitmap which is less than or equal to the number of pixels specified \r
by Width and Height. If no such bitmap exists, then EFI_NOT_FOUND is returned. \r
\r
- @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
- @param[in,out] Width On entry, points to the desired bitmap width. If NULL then no bitmap information will \r
- be returned. On exit, points to the width of the bitmap returned.\r
- @param[in,out] Height On entry, points to the desired bitmap height. If NULL then no bitmap information will \r
- be returned. On exit, points to the height of the bitmap returned\r
- @param[out] Hii On return, holds the HII database handle. \r
- @param[out] Image On return, holds the HII image identifier. \r
+ @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
+ @param[in, out] Width On entry, points to the desired bitmap width. If NULL then no bitmap\r
+ information will be returned. On exit, points to the width of the \r
+ bitmap returned.\r
+ @param[in, out] Height On entry, points to the desired bitmap height. If NULL then no bitmap \r
+ information will be returned. On exit, points to the height of the \r
+ bitmap returned\r
+ @param[out] Hii On return, holds the HII database handle. \r
+ @param[out] Image On return, holds the HII image identifier. \r
\r
- @retval EFI_SUCCESS Image identifier returned successfully.\r
- @retval EFI_NOT_FOUND Image identifier not returned.\r
+ @retval EFI_SUCCESS Image identifier returned successfully.\r
+ @retval EFI_NOT_FOUND Image identifier not returned.\r
+ @retval EFI_INVALID_PARAMETER Hii is NULL or Image is NULL.\r
**/\r
typedef\r
EFI_STATUS\r
This function returns a string which describes the credential provider. If no such string exists, then \r
EFI_NOT_FOUND is returned. \r
\r
- @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
- @param[out] Hii On return, holds the HII database handle.\r
- @param[out] String On return, holds the HII string identifier.\r
+ @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
+ @param[out] Hii On return, holds the HII database handle.\r
+ @param[out] String On return, holds the HII string identifier.\r
\r
- @retval EFI_SUCCESS String identifier returned successfully.\r
- @retval EFI_NOT_FOUND String identifier not returned.\r
+ @retval EFI_SUCCESS String identifier returned successfully.\r
+ @retval EFI_NOT_FOUND String identifier not returned.\r
+ @retval EFI_INVALID_PARAMETER Hii is NULL or String is NULL.\r
**/\r
typedef\r
EFI_STATUS\r
function is called after the credential-related information has been submitted on a form OR after a \r
call to Default() has returned that this credential is ready to log on.\r
\r
- @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
- @param[in] User The user profile handle of the user profile currently being considered by the user \r
- identity manager. If NULL, then no user profile is currently under consideration.\r
- @param[out] Identifier On return, points to the user identifier. \r
+ @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
+ @param[in] User The user profile handle of the user profile currently being considered \r
+ by the user identity manager. If NULL, then no user profile is currently \r
+ under consideration.\r
+ @param[out] Identifier On return, points to the user identifier. \r
\r
- @retval EFI_SUCCESS User identifier returned successfully.\r
- @retval EFI_NOT_READY No user identifier can be returned.\r
- @retval EFI_ACCESS_DENIED The user has been locked out of this user credential.\r
+ @retval EFI_SUCCESS User identifier returned successfully.\r
+ @retval EFI_NOT_READY No user identifier can be returned.\r
+ @retval EFI_ACCESS_DENIED The user has been locked out of this user credential.\r
+ @retval EFI_NOT_FOUND User is not NULL, and the specified user handle can't be found in user \r
+ profile database \r
+ @retval EFI_INVALID_PARAMETER Identifier is NULL.\r
**/\r
typedef\r
EFI_STATUS\r
This function is called when a credential provider is selected by the user. If AutoLogon returns \r
FALSE, then the user interface will be constructed by the User Identity Manager. \r
\r
- @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
- @param[out] AutoLogon On return, points to the credential provider's capabilities after the credential provider \r
- has been selected by the user. \r
+ @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
+ @param[out] AutoLogon On return, points to the credential provider's capabilities after \r
+ the credential provider has been selected by the user. \r
\r
- @retval EFI_SUCCESS Credential provider successfully selected.\r
+ @retval EFI_SUCCESS Credential provider successfully selected.\r
+ @retval EFI_INVALID_PARAMETER AutoLogon is NULL.\r
**/\r
typedef\r
EFI_STATUS\r
\r
This function reports the default login behavior regarding this credential provider. \r
\r
- @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
- @param[out] AutoLogon On return, holds whether the credential provider should be used by default to \r
- automatically log on the user. \r
+ @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
+ @param[out] AutoLogon On return, holds whether the credential provider should be \r
+ used by default to automatically log on the user. \r
\r
- @retval EFI_SUCCESS Default information successfully returned.\r
+ @retval EFI_SUCCESS Default information successfully returned.\r
+ @retval EFI_INVALID_PARAMETER AutoLogon is NULL.\r
**/\r
typedef \r
EFI_STATUS\r
information. \r
\r
@retval EFI_SUCCESS Information returned successfully.\r
- @retval EFI_ACCESS_DENIED The information about the specified user cannot be accessed by the \r
- current user.\r
@retval EFI_BUFFER_TOO_SMALL The size specified by InfoSize is too small to hold all of the user \r
information. The size required is returned in *InfoSize.\r
+ @retval EFI_NOT_FOUND The specified UserInfo does not refer to a valid user info handle.\r
+ @retval EFI_INVALID_PARAMETER Info is NULL or InfoSize is NULL. \r
**/\r
typedef\r
EFI_STATUS\r
);\r
\r
/**\r
- Enumerate all of the enrolled users on the platform.\r
+ Enumerate all of the user information records on the credential provider.\r
\r
This function returns the next user information record. To retrieve the first user information record \r
handle, point UserInfo at a NULL. Each subsequent call will retrieve another user information \r
record handle until there are no more, at which point UserInfo will point to NULL. \r
\r
- @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
- @param[in,out] UserInfo On entry, points to the previous user information handle or NULL to start \r
- enumeration. On exit, points to the next user information handle or NULL if there is \r
- no more user information.\r
+ @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
+ @param[in,out] UserInfo On entry, points to the previous user information handle or NULL to \r
+ start enumeration. On exit, points to the next user information handle \r
+ or NULL if there is no more user information.\r
\r
- @retval EFI_SUCCESS User information returned.\r
- @retval EFI_NOT_FOUND No more user information found.\r
+ @retval EFI_SUCCESS User information returned.\r
+ @retval EFI_NOT_FOUND No more user information found.\r
+ @retval EFI_INVALID_PARAMETER UserInfo is NULL.\r
**/\r
typedef\r
EFI_STATUS\r
projects / mirror_edk2.git / blobdiff