IPXV_Inst::SetStdFolder Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(3 intermediate revisions by 2 users not shown)
Line 9: Line 9:
 
== Syntax ==
 
== Syntax ==
 
<pre class="brush:cpp;gutter:false">HRESULT SetStdFolder([in]  PXV_StdFolderID  nFolderID,
 
<pre class="brush:cpp;gutter:false">HRESULT SetStdFolder([in]  PXV_StdFolderID  nFolderID,
                     [in]  BSTR            pFolderPath,
+
                     [in]  BSTR            sFolderPath,
 
                     [in]  VARIANT_BOOL    bUser);</pre>
 
                     [in]  VARIANT_BOOL    bUser);</pre>
  
Line 15: Line 15:
 
;nFolderID
 
;nFolderID
 
:[in]  Values of [[PXV:PXV_StdFolderID|PXV_StdFolderID]] enumeration.
 
:[in]  Values of [[PXV:PXV_StdFolderID|PXV_StdFolderID]] enumeration.
;pFolderPath
+
;sFolderPath
:[in]  Specifies the path to folder.
+
:[in]  Specifies the path to the folder.
 
;bUser
 
;bUser
 
:[in]  Specify this flag to <tt>true</tt> to change user's folder or to <tt>false</tt> to change the application's folder.  
 
:[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 ==
 
== 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.
 
You may call this function ''before'' calling of [[PXV:IPXV_Inst_Init|IPXV_Inst::Init]] to change some program folders from default to custom.
  

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.

See Also

IPXV_Inst, IPXV_Inst::GetStdFolder