IAFS_BindContext::OnGetUserAccount Method

Revision as of 16:35, 19 August 2015

Called by the file system, to acquire user account info that is required to access data. Should not display any dialogues if silent mode is requested.

Syntax

HRESULT OnGetUserAccount([in]                      IAFS_Name*  pName,
                         [in]                      LPWSTR      pTitle,
                         [in]                      LPWSTR      pText,
                         [out]                     BSTR*       ppUserName,
                         [out]                     BSTR*       ppPassword,
                         [in, defaultvalue(NULL)]  IUnknown*   pIcon,
                         [in, defaultvalue(0)]     LONG        nFlags);

Parameters

pName

[in] Specifies resource name that requires the authentication process to get access to it.

pTitle

[in] The title for the dialog that should be displayed.

pText

[in] The text for the dialog that should be displayed.

ppUserName

[out] Pointer to a buffer, that receives a pointer to the account user name string.

ppPassword

[out] Pointer to a buffer, that receives a pointer to the account password string.

pIcon

[in, optional] Icon to be shown in the dialog. Should provide IUIX_Icon or IUIX_ImageData interface.

nFlags

[in, defaultvalue(0)] If AFS_BindContext_NoUI flag is passed, no UI should be shown.

Return Value

Returns S_OK if the operation was successful, otherwise an error code is returned.

See Also

IAFS_BindContext

IUIX_Icon

IUIX_ImageData

AFS_BindContextFlags