IPXV_Inst::GetStdFolder Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 5: | Line 5: | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT GetStdFolder([in] PXV_StdFolderID nFolderID, [in] VARIANT_BOOL bUser, [in, | + | <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 == | ||
| Line 13: | Line 13: | ||
:[in] Value of VARIANT_BOOL indicates User folder. | :[in] Value of VARIANT_BOOL indicates User folder. | ||
;''bCreateIfNotExists'' | ;''bCreateIfNotExists'' | ||
| − | :[in, | + | :[in, defaultvalue(0)] Value of VARIANT_BOOL to create folder if it does not exist. |
;''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. | ||
Revision as of 01:30, 17 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.
