IPXV_Inst::LoadUserSettings Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#customTitle:IPXV_Inst::LoadUserSettings Method}} | {{#customTitle:IPXV_Inst::LoadUserSettings Method}} | ||
{{#parentPage:PXV:IPXV_Inst#Methods|LoadUserSettings|method}} | {{#parentPage:PXV:IPXV_Inst#Methods|LoadUserSettings|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | + | Load all user's preferences from the specified storage. | |
== Syntax == | == Syntax == | ||
| Line 14: | Line 13: | ||
== Parameters == | == Parameters == | ||
;pUserSettingsSrc | ;pUserSettingsSrc | ||
| − | :[in] Pointer to | + | :[in] A Pointer to [[PXV:IAFS_Name|IAFS_Name]]/[[PXV:IAFS_File|IAFS_File]]/IStream object that specifies the source of all user's preferences. Also via [[PXV:IString|IString]] (see [[PXV:IPXV_Inst_CreateString|IPXV_Inst::CreateString]]) 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\PDFEditorSettings</tt> | ||
| + | :<tt>HKEY_LOCAL_MACHINE\Software\MyApp\PDFEditorSettings</tt> | ||
| + | The list of supported registry-root names: <tt>HKEY_CLASSES_ROOT, HKCR, HKEY_CURRENT_USER, HKCU, HKEY_LOCAL_MACHINE, HKLM</tt>. | ||
;nFlags | ;nFlags | ||
| − | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] The reserved parameter. Pass 0 there. |
== Return Value == | == Return Value == | ||
Latest revision as of 02:06, 20 February 2017
Load all user's preferences from the specified storage.
Syntax
HRESULT LoadUserSettings([in] IUnknown* pUserSettingsSrc,
[in, defaultvalue(0)] LONG nFlags);
Parameters
- pUserSettingsSrc
- [in] A Pointer to IAFS_Name/IAFS_File/IStream object that specifies the source of all user's preferences. Also via IString (see IPXV_Inst::CreateString) 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\PDFEditorSettings
- HKEY_LOCAL_MACHINE\Software\MyApp\PDFEditorSettings
The list of supported registry-root names: HKEY_CLASSES_ROOT, HKCR, HKEY_CURRENT_USER, HKCU, HKEY_LOCAL_MACHINE, HKLM.
- nFlags
- [in, defaultvalue(0)] The reserved parameter. Pass 0 there.
Return Value
Returns S_OK if operation was successful or error code in other cases.
