IPXV_Inst::GetStdFolder Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
Line 2: Line 2:
 
{{#customTitle:IPXV_Inst::GetStdFolder Method}}
 
{{#customTitle:IPXV_Inst::GetStdFolder Method}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets full path to special program folder.
  
 
== Syntax ==
 
== Syntax ==
Line 9: Line 9:
 
== Parameters ==
 
== Parameters ==
 
;''nFolderID''
 
;''nFolderID''
:[in]  Value of [[PXV:PXV_StdFolderID|PXV_StdFolderID]].
+
:[in]  Value of [[PXV:PXV_StdFolderID|PXV_StdFolderID]] with Folder ID.
 
;''bUser''
 
;''bUser''
:[in]  Value of VARIANT_BOOL.
+
:[in]  Value of VARIANT_BOOL indicates User folder.
 
;''bCreateIfNotExists''
 
;''bCreateIfNotExists''
:[in, optional]  Value of VARIANT_BOOL.
+
:[in, optional]  Value of VARIANT_BOOL to create folder if it does not exist.
 
;''ppFolderPath''
 
;''ppFolderPath''
:[out, retval]  Pointer to BSTR.
+
:[out, retval]  Folder path to specified folder. ''ppFolderPath'' always contains '\' at the end.
  
 
== Return Value ==
 
== Return Value ==
Line 21: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Inst|IPXV_Inst]].
+
See also [[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:PXV_StdFolderID|PXV_StdFolderID]].

Revision as of 04:15, 21 March 2015

Gets full path to special program folder.

Syntax

HRESULT GetStdFolder([in] PXV_StdFolderID nFolderID, [in] VARIANT_BOOL bUser, [in, optional] VARIANT_BOOL bCreateIfNotExists, [out, retval] BSTR* ppFolderPath);

Parameters

nFolderID
[in] Value of PXV_StdFolderID with Folder ID.
bUser
[in] Value of VARIANT_BOOL indicates User folder.
bCreateIfNotExists
[in, optional] Value of VARIANT_BOOL to create folder if it does not exist.
ppFolderPath
[out, retval] Folder path to specified folder. ppFolderPath always contains '\' at the end.

Return Value

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

See Also

See also IPXV_Inst, PXV_StdFolderID.