IAFS_BindContext::OnGetUserAccount Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(17 intermediate revisions by 4 users not shown)
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}}
 
{{ToReview}}
  
−
Retrieves user account requisites. Displays request dialog to user or returns previously stored data 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.
  
 
== 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      pTitle,
+
                         [in]                      LPWSTR      sTitle,
−
                         [in]                      LPWSTR      pText,
+
                         [in]                      LPWSTR      sText,
−
                         [out]                    BSTR*      ppUserName,
+
                        [in]                      LPWSTR      sUserName,
−
                         [out]                    BSTR*      ppPassword,
+
                        [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 21:
 
== Parameters ==
 
== Parameters ==
 
;pName
 
;pName
−
:[in]  Filename, access to which should be granted using returned user account requisites. Pass null to get the requisites for the general access to the file system.
+
:[in]  Specifies resource name that requires the authentication process to get access to it.
−
;pTitle
+
;sTitle
−
:[in]  The title of the request dialog.
+
:[in]  The title for the dialog that should be displayed.
−
;pText
+
;sText
−
:[in]  The text of request that should be shown in the dialog.
+
:[in]  The text for the dialog that should be displayed.
−
;ppUserName
+
;sUserName
−
:[out]  Pointer to a buffer that receives a pointer to the account user name string.
+
:[in]  Value of LPWSTR.
−
;ppPassword
+
;sPassword
−
:[out]  Pointer to a buffer that receives a pointer to the account password string.
+
:[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
 
;pIcon
−
:[in, optional]  Pointer to IUnknown*.
+
:[in, optional]  Icon to be shown in the dialog. Should provide IUIX_Icon or IUIX_ImageData interface.
 
;nFlags
 
;nFlags
−
:[in, defaultvalue(0)]  Value of LONG.
+
:[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 or error code in other cases.
+
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

File Systems Layer > Interfaces > IAFS_BindContext > IAFS_BindContext::OnGetUserAccount Method


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.

See Also

IAFS_BindContext

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IAFS_BindContext_OnGetUserAccount&oldid=51060"