IPXV_Inst::GetStdFolder Method
From PDF XChange PDF SDK
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}} |
− | + | ||
{{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 |
− | :[in] Value of [[PXV:PXV_StdFolderID|PXV_StdFolderID]] | + | :[in] Value of [[PXV:PXV_StdFolderID|PXV_StdFolderID]] enumeration. |
− | ; | + | ;bUser |
− | :[in] | + | :[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: |
− | ; | + | ::<tt>c:\Program Files\Tracker Software\PDF Editor\</tt> |
− | :[in, defaultvalue(0)] | + | ::but with <tt>bUser</tt> specified to <tt>true</tt>: |
− | ; | + | ::<tt>c:\Users\root\AppData\Roaming\Tracker Software\PDFXEditor\3.0\</tt> |
− | :[out, retval] | + | ;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 == | ||
− | + | [[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Inst_SetStdFolder|IPXV_Inst::SetStdFolder]] |
Latest revision as of 16:45, 25 May 2015
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.