IPXV_Inst::GetStdFolder Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| Line 1: | Line 1: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXV_Inst::GetStdFolder Method}} | {{#customTitle:IPXV_Inst::GetStdFolder Method}} | ||
| − | {{#parentPage:PXV:IPXV_Inst|method}} | + | {{#parentPage:PXV:IPXV_Inst|GetStdFolder Method|method}} |
{{ToReview}} | {{ToReview}} | ||
| Line 7: | Line 7: | ||
== 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]] with Folder ID. | :[in] Value of [[PXV:PXV_StdFolderID|PXV_StdFolderID]] with Folder ID. | ||
| − | ; | + | ;bUser |
:[in] Value of VARIANT_BOOL indicates User folder. | :[in] Value of VARIANT_BOOL indicates User folder. | ||
| − | ; | + | ;bCreateIfNotExists |
:[in, defaultvalue(0)] Value of VARIANT_BOOL to create folder if it does not exist. | :[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. | :[out, retval] Folder path to specified folder. ''ppFolderPath'' always contains '\' at the end. | ||
Revision as of 06:25, 23 April 2015
Gets full path to special program folder.
Contents
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.
Return Value
Returns S_OK if operation was successful or error code in other cases.
See Also
See also IPXV_Inst, PXV_StdFolderID.
