IPXV_Inst::ShowSelectFolderDlg Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 3: Line 3:
 
{{#customTitle:IPXV_Inst::ShowSelectFolderDlg Method}}
 
{{#customTitle:IPXV_Inst::ShowSelectFolderDlg Method}}
 
{{#parentPage:PXV:IPXV_Inst#Methods|ShowSelectFolderDlg|method}}
 
{{#parentPage:PXV:IPXV_Inst#Methods|ShowSelectFolderDlg|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Shows an ''Select Folder'' dialog box that lets the user specify the name of a file(s) to be opened.  
  
 
== Syntax ==
 
== Syntax ==
Line 17: Line 16:
 
== Parameters ==
 
== Parameters ==
 
;pInitialFolderName
 
;pInitialFolderName
:[in, defaultvalue("")]  Value of BSTR.
+
:[in, defaultvalue("")]  The initial folder path. If empty string is specified then current folder will be used.
 
;pDlgTitle
 
;pDlgTitle
:[in, defaultvalue("")]  Value of BSTR.
+
:[in, defaultvalue("")]  The title of dialog.
 
;hWndParent
 
;hWndParent
:[in, defaultvalue(0)]  Value of HANDLE_T.
+
:[in, defaultvalue(0)]  The optional parameter that specifies the handle of parent window.
 
;bCanAddNew
 
;bCanAddNew
:[in, defaultvalue(-1)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(-1)]  The flags to include the ''New Folder'' button in the dialog box.
 
;ppRes
 
;ppRes
:[out, retval]  Pointer to [[PXV:IAFS_Name|IAFS_Name]].
+
:[out, retval]  Returns pointer to [[PXV:IAFS_Name|IAFS_Name]] object.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 18:48, 26 May 2015


Shows an Select Folder dialog box that lets the user specify the name of a file(s) to be opened.

Syntax

HRESULT ShowSelectFolderDlg([in, defaultvalue("")]  BSTR          pInitialFolderName,
                            [in, defaultvalue("")]  BSTR          pDlgTitle,
                            [in, defaultvalue(0)]   HANDLE_T      hWndParent,
                            [in, defaultvalue(-1)]  VARIANT_BOOL  bCanAddNew,
                            [out, retval]           IAFS_Name**   ppRes);

Parameters

pInitialFolderName
[in, defaultvalue("")] The initial folder path. If empty string is specified then current folder will be used.
pDlgTitle
[in, defaultvalue("")] The title of dialog.
hWndParent
[in, defaultvalue(0)] The optional parameter that specifies the handle of parent window.
bCanAddNew
[in, defaultvalue(-1)] The flags to include the New Folder button in the dialog box.
ppRes
[out, retval] Returns pointer to IAFS_Name object.

Return Value

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

See Also

IPXV_Inst