IPXV_Inst::SetStdFolder Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 8: Line 8:
  
 
== 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  FolderID,
                     [in]  BSTR            sFolderPath,
+
                     [in]  BSTR            FolderPath,
                     [in]  VARIANT_BOOL    bUser);</pre>
+
                     [in]  VARIANT_BOOL    User);</pre>
  
 
== Parameters ==
 
== Parameters ==
;nFolderID
+
;FolderID
 
:[in]  Values of [[PXV:PXV_StdFolderID|PXV_StdFolderID]] enumeration.
 
:[in]  Values of [[PXV:PXV_StdFolderID|PXV_StdFolderID]] enumeration.
;sFolderPath
+
;FolderPath
 
:[in]  Specifies the path to the folder.
 
:[in]  Specifies the path to the folder.
;bUser
+
;User
 
:[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.  
  

Revision as of 07:33, 12 June 2015


Changes location of special program folder.

Syntax

HRESULT SetStdFolder([in]  PXV_StdFolderID  FolderID,
                     [in]  BSTR             FolderPath,
                     [in]  VARIANT_BOOL     User);

Parameters

FolderID
[in] Values of PXV_StdFolderID enumeration.
FolderPath
[in] Specifies the path to the folder.
User
[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