IAFS_BindContext::OnGetUserAccount Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
(27 intermediate revisions by 4 users not shown) | |||
Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IAFS_BindContext::OnGetUserAccount Method}} | {{#customTitle:IAFS_BindContext::OnGetUserAccount Method}} | ||
− | {{#parentPage:PXV:IAFS_BindContext|OnGetUserAccount | + | {{#parentPage:PXV:IAFS_BindContext#Methods|OnGetUserAccount|method}} |
{{ToWrite}} | {{ToWrite}} | ||
{{ToReview}} | {{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. | |
== 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 19: | Line 21: | ||
== Parameters == | == Parameters == | ||
;pName | ;pName | ||
− | :[in] | + | :[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. | :[in] Value of LPWSTR. | ||
− | ; | + | ;sPassword |
:[in] Value of LPWSTR. | :[in] Value of LPWSTR. | ||
− | ; | + | ;sUserNameOut |
− | :[out] Pointer to | + | :[out] Pointer to a buffer, that receives a pointer to the account user name string. |
− | ; | + | ;sPasswordOut |
− | :[out] Pointer to | + | :[out] Pointer to a buffer, that receives a pointer to the account password string. |
;pIcon | ;pIcon | ||
− | :[in, optional] | + | :[in, optional] Icon to be shown in the dialog. Should provide IUIX_Icon or IUIX_ImageData interface. |
;nFlags | ;nFlags | ||
− | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] If AFS_BindContext_NoUI flag is passed, no UI should be shown. |
== Return Value == | == Return Value == | ||
− | Returns S_OK if operation was successful | + | Returns S_OK if the operation was successful, otherwise an error code is returned. |
== See Also == | == See Also == | ||
− | [[PXV:IAFS_BindContext|IAFS_BindContext]] | + | [[PXV:IAFS_BindContext|IAFS_BindContext]] |
Latest revision as of 23:49, 30 November 2017
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.