IPXV_Inst::GetStdFolder Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
Line 22: | Line 22: | ||
;ppFolderPath | ;ppFolderPath | ||
:[out, retval] Folder path to specified folder. ''ppFolderPath'' always contains '\' at the end. | :[out, retval] Folder path to specified folder. ''ppFolderPath'' always contains '\' at the end. | ||
+ | |||
+ | == Remarks == | ||
+ | The boolean parameter <tt>bUser</tt> controls 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> | ||
+ | :but with <tt>bUser</tt> specified to <tt>true</tt>: | ||
+ | ::<tt>c:\Users\root\AppData\Roaming\Tracker Software\PDFXEditor\3.0\</tt> | ||
+ | |||
+ | |||
== Return Value == | == Return Value == |
Revision as of 15:33, 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 with Folder ID.
- bUser
- [in] Value of VARIANT_BOOL indicates User folder.
- bCreateIfNotExists
- [in, defaultvalue(0)] 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.
Remarks
The boolean parameter bUser controls 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\
Return Value
Returns S_OK if operation was successful or error code in other cases.