IAFS_BindContext::OnGetUserAccount Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 5: Line 5:
 
{{ToReview}}
 
{{ToReview}}
  
Called by the file system to acquire user account attributes that required. Should not display any dialogs if silent mode being requested.
+
Called by the file system to acquire user account attributes that required to access data. Should not display any dialogs if silent mode being requested.
  
 
== Syntax ==
 
== Syntax ==

Revision as of 02:31, 26 May 2015


Called by the file system to acquire user account attributes that required to access data. Should not display any dialogs if silent mode being 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 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 show in the dialog. Should provide IUIX_Icon or IUIX_ImageData interface.
nFlags
[in, defaultvalue(0)] Pass AFS_BindContext_NoUI flag for silent mode or 0 for dialog request.

Return Value

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

See Also

IAFS_BindContext
IUIX_Icon
IUIX_ImageData
AFS_BindContextFlags