IAFS_BindContext::OnGetUserAccount Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#customTitle:IAFS_BindContext::OnGetUserAccount Method}} | {{#customTitle:IAFS_BindContext::OnGetUserAccount Method}} | ||
{{#parentPage:PXV:IAFS_BindContext#Methods|OnGetUserAccount|method}} | {{#parentPage:PXV:IAFS_BindContext#Methods|OnGetUserAccount|method}} | ||
| + | {{ToWrite}} | ||
| + | {{ToReview}} | ||
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. | 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. | ||
| Line 8: | Line 10: | ||
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">HRESULT OnGetUserAccount([in] IAFS_Name* pName, | <pre class="brush:cpp;gutter:false">HRESULT OnGetUserAccount([in] IAFS_Name* pName, | ||
| − | [in] LPWSTR | + | [in] LPWSTR sTitle, |
| − | [in] LPWSTR | + | [in] LPWSTR sText, |
| − | [out] BSTR* | + | [in] LPWSTR sUserName, |
| − | [out] BSTR* | + | [in] LPWSTR sPassword, |
| + | [out] BSTR* sUserNameOut, | ||
| + | [out] BSTR* sPasswordOut, | ||
[in, defaultvalue(NULL)] IUnknown* pIcon, | [in, defaultvalue(NULL)] IUnknown* pIcon, | ||
[in, defaultvalue(0)] LONG nFlags);</pre> | [in, defaultvalue(0)] LONG nFlags);</pre> | ||
| Line 18: | Line 22: | ||
;pName | ;pName | ||
:[in] Specifies resource name that requires the authentication process to get access to it. | :[in] Specifies resource name that requires the authentication process to get access to it. | ||
| − | ; | + | ;sTitle |
:[in] The title for the dialog that should be displayed. | :[in] The title for the dialog that should be displayed. | ||
| − | ; | + | ;sText |
:[in] The text for the dialog that should be displayed. | :[in] The text for the dialog that should be displayed. | ||
| − | ; | + | ;sUserName |
| + | :[in] Value of LPWSTR. | ||
| + | ;sPassword | ||
| + | :[in] Value of LPWSTR. | ||
| + | ;sUserNameOut | ||
:[out] Pointer to a buffer, that receives a pointer to the account user name string. | :[out] Pointer to a buffer, that receives a pointer to the account user name string. | ||
| − | ; | + | ;sPasswordOut |
:[out] Pointer to a buffer, that receives a pointer to the account password string. | :[out] Pointer to a buffer, that receives a pointer to the account password string. | ||
;pIcon | ;pIcon | ||
Revision as of 00:52, 20 October 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 sTitle,
[in] LPWSTR sText,
[in] LPWSTR sUserName,
[in] LPWSTR sPassword,
[out] BSTR* sUserNameOut,
[out] BSTR* sPasswordOut,
[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.
- sTitle
- [in] The title for the dialog that should be displayed.
- sText
- [in] The text for the dialog that should be displayed.
- sUserName
- [in] Value of LPWSTR.
- sPassword
- [in] Value of LPWSTR.
- sUserNameOut
- [out] Pointer to a buffer, that receives a pointer to the account user name string.
- sPasswordOut
- [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.
