IPXV_Inst::Init Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 1: Line 1:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::Init Method}}
 
{{#customTitle:IPXV_Inst::Init Method}}
{{#parentPage:PXV:IPXV_Inst|method}}
+
{{#parentPage:PXV:IPXV_Inst|Init Method|method}}
 
{{ToWrite}}
 
{{ToWrite}}
 
{{ToReview}}
 
{{ToReview}}
Line 8: Line 8:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Init([in, optional] IUnknown* pCtx,
+
<pre class="brush:cpp;gutter:false">HRESULT Init([in, optional] IUnknown* pCtx, [in, defaultvalue("")] BSTR pLicKey, [in, optional] IUnknown* pUserSettingsSrc, [in, optional] IUnknown* pHistorySrc, [in, optional] IUnknown* pHistoryThumbsSrc, [in, defaultvalue(0)] LONG nFlags, [in, optional] IUnknown* pReserved);</pre>
            [in, optional] IUnknown* pUserSettingsSrc,
+
            [in, optional] BSTR pRegistryPathToSettings,
+
            [in, optional] IAFS_Name* pHistoryFileName,
+
            [in, optional] BSTR pRegistryPathToHistory,
+
            [in, optional] IAFS_Name* pHistoryThumbsFileName,
+
            [in, optional] LONG nFlags,
+
            [in, optional] IUnknown* pReserved);
+
</pre>
+
  
 
== Parameters ==
 
== Parameters ==
;''pCtx''
+
;pCtx
 
:[in, optional]  A pointer to '''IUnknown''' interface of context-object. This parameter is optional and can be NULL.
 
:[in, optional]  A pointer to '''IUnknown''' interface of context-object. This parameter is optional and can be NULL.
;''pUserSettingsSrc''
+
;pUserSettingsSrc
 
:[in, optional]  A pointer to [[PXV:IAFS_Name|IAFS_Name]]/[[PXV:IAFS_File|IAFS_File]] object that specifies path to a source of all user's preferences. This parameter is optional and can be NULL.
 
:[in, optional]  A pointer to [[PXV:IAFS_Name|IAFS_Name]]/[[PXV:IAFS_File|IAFS_File]] object that specifies path to a source of all user's preferences. This parameter is optional and can be NULL.
;''pRegistryPathToSettings''
+
;pRegistryPathToSettings
 
:[in, optional]  Path to custom location in system's registry that contains all user's preferences. This parameter is optional and can be NULL.
 
:[in, optional]  Path to custom location in system's registry that contains all user's preferences. This parameter is optional and can be NULL.
;''pHistoryFileName''
+
;pHistoryFileName
 
:[in, optional]  Pointer to [[PXV:IAFS_Name|IAFS_Name]] object that specifies the path to a source of documents opening history. This parameter is optional and can be NULL.
 
:[in, optional]  Pointer to [[PXV:IAFS_Name|IAFS_Name]] object that specifies the path to a source of documents opening history. This parameter is optional and can be NULL.
;''pRegistryPathToHistory''
+
;pRegistryPathToHistory
 
:[in, optional]  Path to a custom location in system's registry that contains documents opening history. This parameter is optional and can be NULL.
 
:[in, optional]  Path to a custom location in system's registry that contains documents opening history. This parameter is optional and can be NULL.
;''pHistoryThumbsFileName''
+
;pHistoryThumbsFileName
 
:[in, optional]  Pointer to [[PXV:IAFS_Name|IAFS_Name]] object that specifies the path to a source of documents opening history thumbnails cache. This parameter is optional and can be NULL.
 
:[in, optional]  Pointer to [[PXV:IAFS_Name|IAFS_Name]] object that specifies the path to a source of documents opening history thumbnails cache. This parameter is optional and can be NULL.
;''nFlags''
+
;nFlags
 
:[in, optional]  The advanced flags. This parameter is optional and can be 0.
 
:[in, optional]  The advanced flags. This parameter is optional and can be 0.
;''pReserved''
+
;pReserved
 
:[in, optional]  The reserved parameter. Pass NULL there.
 
:[in, optional]  The reserved parameter. Pass NULL there.
  

Revision as of 13:24, 22 April 2015


This method initializes the main object instance and must be called first, before of calling any other method.

Syntax

HRESULT Init([in, optional] IUnknown* pCtx, [in, defaultvalue("")] BSTR pLicKey, [in, optional] IUnknown* pUserSettingsSrc, [in, optional] IUnknown* pHistorySrc, [in, optional] IUnknown* pHistoryThumbsSrc, [in, defaultvalue(0)] LONG nFlags, [in, optional] IUnknown* pReserved);

Parameters

pCtx
[in, optional] A pointer to IUnknown interface of context-object. This parameter is optional and can be NULL.
pUserSettingsSrc
[in, optional] A pointer to IAFS_Name/IAFS_File object that specifies path to a source of all user's preferences. This parameter is optional and can be NULL.
pRegistryPathToSettings
[in, optional] Path to custom location in system's registry that contains all user's preferences. This parameter is optional and can be NULL.
pHistoryFileName
[in, optional] Pointer to IAFS_Name object that specifies the path to a source of documents opening history. This parameter is optional and can be NULL.
pRegistryPathToHistory
[in, optional] Path to a custom location in system's registry that contains documents opening history. This parameter is optional and can be NULL.
pHistoryThumbsFileName
[in, optional] Pointer to IAFS_Name object that specifies the path to a source of documents opening history thumbnails cache. This parameter is optional and can be NULL.
nFlags
[in, optional] The advanced flags. This parameter is optional and can be 0.
pReserved
[in, optional] The reserved parameter. Pass NULL there.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

See also IPXV_Inst, IAFS_Name, IAFS_File.