IAFS_BindContext::OnGetUserAccount Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 4: Line 4:
 
{{#parentPage:PXV:IAFS_BindContext#Methods|OnGetUserAccount|method}}
 
{{#parentPage:PXV:IAFS_BindContext#Methods|OnGetUserAccount|method}}
  
Called by the file system to acquire user account attributes required to access data. Should not display any dialogs if silent mode being requested.
+
Called by, the file system, to acquire user account attributes that are required to access data. Should not display any dialogues if silent mode is requested.
  
 
== Syntax ==
 
== Syntax ==
Line 17: Line 17:
 
== Parameters ==
 
== Parameters ==
 
;pName
 
;pName
:[in]  If this value is null then general access to the user account is required. Otherwise, requested account attributes should provide access to the specified file.
+
:[in]  If this value is null, then general access to the user account is required. Otherwise, requested account attributes should provide access to the specified file.
 
;pTitle
 
;pTitle
 
:[in]  The title for the dialog that should be displayed.
 
:[in]  The title for the dialog that should be displayed.
Line 23: Line 23:
 
:[in]  The text for the dialog that should be displayed.
 
:[in]  The text for the dialog that should be displayed.
 
;ppUserName
 
;ppUserName
:[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.
 
;ppPassword
 
;ppPassword
:[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
 
:[in, optional]  Icon to be shown in the dialog. Should provide IUIX_Icon or IUIX_ImageData interface.
 
:[in, optional]  Icon to be shown in the dialog. Should provide IUIX_Icon or IUIX_ImageData interface.
 
;nFlags
 
;nFlags
:[in, defaultvalue(0)]  If AFS_BindContext_NoUI flag is passed no UI should be shown.
+
:[in, defaultvalue(0)]  If AFS_BindContext_NoUI flag is passed, no UI should be shown.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if the operation was successful otherwise an error code is returned.
+
Returns S_OK if the operation was successful, otherwise an error code is returned.
  
 
== See Also ==
 
== See Also ==

Revision as of 11:20, 28 May 2015

Called by, the file system, to acquire user account attributes that are required to access data. Should not display any dialogues 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] If this value is null, then general access to the user account is required. Otherwise, requested account attributes should provide access to the specified file.
pTitle
[in] The title for the dialog that should be displayed.
pText
[in] The text for the dialog that should be displayed.
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 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
IUIX_Icon
IUIX_ImageData
AFS_BindContextFlags