\r
Attached to a device handle, this protocol identifies a single means of identifying the user.\r
\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
+ Copyright (c) 2009 - 2018, 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
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
Enroll a user on a credential provider.\r
\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
+ 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
- \r
+\r
@retval EFI_SUCCESS User profile was successfully enrolled.\r
- @retval EFI_ACCESS_DENIED Current user profile does not permit enrollment on the user profile \r
- handle. Either the user profile cannot enroll on any user profile or \r
+ @retval EFI_ACCESS_DENIED Current user profile does not permit enrollment on the user profile\r
+ handle. Either the user profile cannot enroll on any user profile or\r
cannot enroll on a user profile other than the current user profile.\r
@retval EFI_UNSUPPORTED This credential provider does not support enrollment in the pre-OS.\r
@retval EFI_DEVICE_ERROR The new credential could not be created because of a device error.\r
/**\r
Returns the user interface information used during user identification.\r
\r
- This function returns information about the form used when interacting with the user during user \r
- identification. The form is the first enabled form in the form-set class \r
- EFI_HII_USER_CREDENTIAL_FORMSET_GUID installed on the HII handle HiiHandle. If \r
- the user credential provider does not require a form to identify the user, then this function should \r
+ This function returns information about the form used when interacting with the user during user\r
+ identification. The form is the first enabled form in the form-set class\r
+ EFI_HII_USER_CREDENTIAL_FORMSET_GUID installed on the HII handle HiiHandle. If\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 \r
+ @param[out] FormId On return, holds the identifier of the form used during user\r
identification.\r
- \r
+\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
Returns bitmap used to describe the credential provider type.\r
\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
+ 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\r
- information will be returned. On exit, points to the width of the \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
+ @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
+ @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_INVALID_PARAMETER Hii is NULL or Image is NULL.\r
/**\r
Returns string used to describe the credential provider type.\r
\r
- This function returns a string which describes the credential provider. If no such string exists, then \r
- EFI_NOT_FOUND is returned. \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
- \r
+\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
Return the user identifier associated with the currently authenticated user.\r
\r
- This function returns the user identifier of the user authenticated by this credential provider. This \r
- function is called after the credential-related information has been submitted on a form OR after a \r
+ This function returns the user identifier of the user authenticated by this credential provider. This\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 \r
- by the user identity manager. If NULL, then no user profile is currently \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
+ @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_NOT_FOUND User is not NULL, and the specified user handle can't be found in user \r
- profile database \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
/**\r
Indicate that user interface interaction has begun for the specified credential.\r
\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
+ 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 \r
- the credential provider has been selected by the user. \r
- \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_INVALID_PARAMETER AutoLogon is NULL.\r
**/\r
(EFIAPI *EFI_CREDENTIAL_SELECT)(\r
IN CONST EFI_USER_CREDENTIAL_PROTOCOL *This,\r
OUT EFI_CREDENTIAL_LOGON_FLAGS *AutoLogon\r
- ); \r
+ );\r
\r
/**\r
Indicate that user interface interaction has ended for the specified credential.\r
This function is called when a credential provider is deselected by the user.\r
\r
@param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
- \r
+\r
@retval EFI_SUCCESS Credential provider successfully deselected.\r
**/\r
typedef\r
/**\r
Return the default logon behavior for this user credential.\r
\r
- This function reports the default login behavior regarding this credential provider. \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 \r
- used by default to automatically log on the user. \r
- \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_INVALID_PARAMETER AutoLogon is NULL.\r
**/\r
-typedef \r
+typedef\r
EFI_STATUS\r
(EFIAPI *EFI_CREDENTIAL_DEFAULT)(\r
IN CONST EFI_USER_CREDENTIAL_PROTOCOL *This,\r
/**\r
Return information attached to the credential provider.\r
\r
- This function returns user information. \r
+ This function returns user information.\r
\r
@param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
- @param[in] UserInfo Handle of the user information data record. \r
- @param[out] Info On entry, points to a buffer of at least *InfoSize bytes. On exit, holds the user \r
- information. If the buffer is too small to hold the information, then \r
- EFI_BUFFER_TOO_SMALL is returned and InfoSize is updated to contain the \r
+ @param[in] UserInfo Handle of the user information data record.\r
+ @param[out] Info On entry, points to a buffer of at least *InfoSize bytes. On exit, holds the user\r
+ information. If the buffer is too small to hold the information, then\r
+ EFI_BUFFER_TOO_SMALL is returned and InfoSize is updated to contain the\r
number of bytes actually required.\r
- @param[in,out] InfoSize On entry, points to the size of Info. On return, points to the size of the user \r
- information. \r
- \r
+ @param[in,out] InfoSize On entry, points to the size of Info. On return, points to the size of the user\r
+ information.\r
+\r
@retval EFI_SUCCESS Information returned successfully.\r
- @retval EFI_BUFFER_TOO_SMALL The size specified by InfoSize is too small to hold all of the 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
+ @retval EFI_INVALID_PARAMETER Info is NULL or InfoSize is NULL.\r
**/\r
typedef\r
EFI_STATUS\r
/**\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
+ 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 \r
- start enumeration. On exit, points to the next user information handle \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
+\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
EFI_CREDENTIAL_TILE Tile;\r
EFI_CREDENTIAL_TITLE Title;\r
EFI_CREDENTIAL_USER User;\r
- EFI_CREDENTIAL_SELECT Select; \r
+ EFI_CREDENTIAL_SELECT Select;\r
EFI_CREDENTIAL_DESELECT Deselect;\r
EFI_CREDENTIAL_DEFAULT Default;\r
EFI_CREDENTIAL_GET_INFO GetInfo;\r
projects / mirror_edk2.git / blobdiff