IPXV_Inst::SetStdFolder Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (14 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXV_Inst::SetStdFolder Method}} | {{#customTitle:IPXV_Inst::SetStdFolder Method}} | ||
| + | {{#parentPage:PXV:IPXV_Inst#Methods|SetStdFolder|method}} | ||
| + | {{ToReview}} | ||
| − | + | Changes location of special program folder. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT SetStdFolder([in] PXV_StdFolderID nFolderID, [in] BSTR | + | <pre class="brush:cpp;gutter:false">HRESULT SetStdFolder([in] PXV_StdFolderID nFolderID, |
| + | [in] BSTR sFolderPath, | ||
| + | [in] VARIANT_BOOL bUser);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;nFolderID |
| − | :[in] | + | :[in] Values of [[PXV:PXV_StdFolderID|PXV_StdFolderID]] enumeration. |
| − | ; | + | ;sFolderPath |
| − | :[in] | + | :[in] Specifies the path to the folder. |
| − | ; | + | ;bUser |
| − | :[in] | + | :[in] Specify this flag to <tt>true</tt> to change user's folder or to <tt>false</tt> to change the application's folder. |
| + | |||
| + | == Remarks == | ||
| + | You may call this function ''before'' calling of [[PXV:IPXV_Inst_Init|IPXV_Inst::Init]] to change some program folders from default to custom. | ||
== Return Value == | == Return Value == | ||
| Line 19: | Line 27: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Inst_GetStdFolder|IPXV_Inst::GetStdFolder]] | |
Latest revision as of 03:57, 15 June 2015
Changes location of special program folder.
Syntax
HRESULT SetStdFolder([in] PXV_StdFolderID nFolderID,
[in] BSTR sFolderPath,
[in] VARIANT_BOOL bUser);
Parameters
- nFolderID
- [in] Values of PXV_StdFolderID enumeration.
- sFolderPath
- [in] Specifies the path to the folder.
- bUser
- [in] Specify this flag to true to change user's folder or to false to change the application's folder.
Remarks
You may call this function before calling of IPXV_Inst::Init to change some program folders from default to custom.
Return Value
Returns S_OK if operation was successful or error code in other cases.
