IAFS_BindContext::OnGetUserAccount Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 5: Line 5:
 
{{ToReview}}
 
{{ToReview}}
  
Retrieves user account requisites. Displays request dialog or performs in silent mode.
+
Retrieves user account requisites. Displays request dialog to user or returns previously stored data if silent mode is requested.
  
 
== Syntax ==
 
== Syntax ==
Line 18: Line 18:
 
== Parameters ==
 
== Parameters ==
 
;pName
 
;pName
:[in]  Filename, access to which should be granted using returned user account attributes. Pass null to get attributes for general access to file system.
+
:[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.
 
;pTitle
 
;pTitle
:[in]  Value of LPWSTR.
+
:[in]  The title of the request dialog.
 
;pText
 
;pText
:[in]  Value of LPWSTR.
+
:[in]  The text of request that should be shown in the dialog.
 
;ppUserName
 
;ppUserName
 
:[out]  Pointer to BSTR.
 
:[out]  Pointer to BSTR.

Revision as of 00:06, 26 May 2015


Retrieves user account requisites. Displays request dialog to user or returns previously stored data 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] 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.
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 BSTR.
ppPassword
[out] Pointer to BSTR.
pIcon
[in, optional] Pointer to IUnknown*.
nFlags
[in, defaultvalue(0)] Value of LONG.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IAFS_BindContext