IPXV_Inst::Init Method

From Tracker Software PDF SDK
Jump to: navigation, search
Line 5: Line 5:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Init([in, optional] IUnknown* pCtx, [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>
+
<pre class="brush:cpp;gutter:false">HRESULT Init(
 +
            [in, optional] IUnknown* pCtx,
 +
            [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 ==

Revision as of 12:15, 16 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, 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);

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.