IPXV_Inst::GetStdFolder Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::GetStdFolder Method}}
 
{{#customTitle:IPXV_Inst::GetStdFolder Method}}
−
{{#parentPage:PXV:IPXV_Inst|method}}
+
{{#parentPage:PXV:IPXV_Inst#Methods|GetStdFolder|method}}
−
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
Line 8: Line 8:
  
 
== Syntax ==
 
== Syntax ==
−
<pre class="brush:cpp;gutter:false">HRESULT GetStdFolder([in] PXV_StdFolderID nFolderID, [in] VARIANT_BOOL bUser, [in, defaultvalue(0)] VARIANT_BOOL bCreateIfNotExists, [out, retval] BSTR* ppFolderPath);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetStdFolder([in]                   PXV_StdFolderID nFolderID,
 +
                    [in]                   VARIANT_BOOL     bUser,
 +
                    [in, defaultvalue(0)] VARIANT_BOOL     bCreateIfNotExists,
 +
                    [out, retval]         BSTR*           ppFolderPath);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;''nFolderID''
+
;nFolderID
−
:[in]  Value of [[PXV:PXV_StdFolderID|PXV_StdFolderID]] with Folder ID.
+
:[in]  Value of [[PXV:PXV_StdFolderID|PXV_StdFolderID]] enumeration.
−
;''bUser''
+
;bUser
−
:[in]  Value of VARIANT_BOOL indicates User folder.
+
:[in]  The boolean flag that indicates what type of path should be in output: application's or user's. For example, by default, for identifier <tt>PXV_StdFolder_Root</tt> and when <tt>bUser</tt> is specified to <tt>false</tt> the function will return:
−
;''bCreateIfNotExists''
+
::<tt>c:\Program Files\Tracker Software\PDF Editor\</tt>
−
:[in, defaultvalue(0)] Value of VARIANT_BOOL to create folder if it does not exist.
+
::but with <tt>bUser</tt> specified to <tt>true</tt>:
−
;''ppFolderPath''
+
::<tt>c:\Users\root\AppData\Roaming\Tracker Software\PDFXEditor\3.0\</tt>
−
:[out, retval]  Folder path to specified folder. ''ppFolderPath'' always contains '\' at the end.
+
;bCreateIfNotExists
 +
:[in, defaultvalue(0)] Indicates whether to create specified folder path when it does not exist.
 +
;ppFolderPath
 +
:[out, retval]  Returns the full path to the specified folder, always contains '\' letter at the end.
  
 
== Return Value ==
 
== Return Value ==
Line 24: Line 30:
  
 
== See Also ==
 
== See Also ==
−
See also [[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:PXV_StdFolderID|PXV_StdFolderID]].
+
[[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Inst_SetStdFolder|IPXV_Inst::SetStdFolder]]

Latest revision as of 16:45, 25 May 2015

PDF Editor Layer > Interfaces > IPXV_Inst > IPXV_Inst::GetStdFolder Method


Gets full path to special program folder.

Syntax

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

Parameters

nFolderID
[in] Value of PXV_StdFolderID enumeration.
bUser
[in] The boolean flag that indicates what type of path should be in output: application's or user's. For example, by default, for identifier PXV_StdFolder_Root and when bUser is specified to false the function will return:
c:\Program Files\Tracker Software\PDF Editor\
but with bUser specified to true:
c:\Users\root\AppData\Roaming\Tracker Software\PDFXEditor\3.0\
bCreateIfNotExists
[in, defaultvalue(0)] Indicates whether to create specified folder path when it does not exist.
ppFolderPath
[out, retval] Returns the full path to the specified folder, always contains '\' letter at the end.

Return Value

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

See Also

IPXV_Inst, IPXV_Inst::SetStdFolder

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IPXV_Inst_GetStdFolder&oldid=38832"