IPXV_Inst::Init Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 20: Line 20:
 
;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.
 +
;pLicKey
 +
:[in, optional]  A pointer to unicode string that contains developer's license key. This parameter is optional and can be empty - in this case the SDK will work in DEMO mode.
 
;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 the source of all user's preferences. This parameter is optional and can be NULL. Also via [[PXV:IString|IString]] you may specify path to local file or path to custom location in system's registry in format for example:
 +
 
 +
:<tt>HKEY_CURRENT_USER\Software\MyApp\PDFEditorSetting</tt>
 +
 
 +
:<tt>HKEY_LOCAL_MACHINE\Software\MyApp\PDFEditorSetting</tt>
 +
 
 +
The list of supported registry-root aliases: <tt>HKEY_CLASSES_ROOT, HKCR, HKEY_CURRENT_USER, HKCU, HKEY_LOCAL_MACHINE, HKLM</tt>.
 +
 
 
;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
+
;pHistorySrc
:[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]]/[[PXV:IAFS_File|IAFS_File]] object that specifies the 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.

Revision as of 12:03, 24 May 2015


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

Syntax

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

Parameters

pCtx
[in, optional] A pointer to IUnknown interface of context-object. This parameter is optional and can be NULL.
pLicKey
[in, optional] A pointer to unicode string that contains developer's license key. This parameter is optional and can be empty - in this case the SDK will work in DEMO mode.
pUserSettingsSrc
[in, optional] A pointer to IAFS_Name/IAFS_File object that specifies the source of all user's preferences. This parameter is optional and can be NULL. Also via IString you may specify path to local file or path to custom location in system's registry in format for example:
HKEY_CURRENT_USER\Software\MyApp\PDFEditorSetting
HKEY_LOCAL_MACHINE\Software\MyApp\PDFEditorSetting

The list of supported registry-root aliases: HKEY_CLASSES_ROOT, HKCR, HKEY_CURRENT_USER, HKCU, HKEY_LOCAL_MACHINE, HKLM.

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.
pHistorySrc
[in, optional] Pointer to IAFS_Name/IAFS_File object that specifies the 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

IPXV_Inst