IAFS_BindContext::OnGetUserAccount Method
From PDF XChange PDF SDK
Line 18: | Line 18: | ||
== Parameters == | == Parameters == | ||
;pName | ;pName | ||
− | :[in] If this value is | + | :[in] If this value is null then general access to the user account is needed. Otherwise, requested account attributes should provide access to the specified file. |
;pTitle | ;pTitle | ||
:[in] The title of the request dialog. | :[in] The title of the request dialog. |
Revision as of 02:40, 26 May 2015
Called by the file system to acquire user account attributes that required to access data. Should not display any dialogs if silent mode being 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] If this value is null then general access to the user account is needed. Otherwise, requested account attributes should provide access to the specified file.
- pTitle
- [in] The title of the request dialog.
- pText
- [in] The text of request that should be shown in the dialog.
- 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 show in the dialog. Should provide IUIX_Icon or IUIX_ImageData interface.
- nFlags
- [in, defaultvalue(0)] Pass AFS_BindContext_NoUI flag for silent mode or 0 for dialog request.
Return Value
Returns S_OK if operation was successful or error code in other cases.