IPXV_Inst::SaveUserSettings Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 14: | Line 14: | ||
== Parameters == | == Parameters == | ||
;pUserSettingsDest | ;pUserSettingsDest | ||
| − | :[in] A 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. 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\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 == | ||
| Line 22: | Line 25: | ||
== See Also == | == See Also == | ||
| − | [[PXV:IPXV_Inst|IPXV_Inst]] | + | [[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Inst_Init|IPXV_Inst::Init]], [[PXV:IPXV_Inst_SaveHistory|IPXV_Inst::SaveHistory]] |
Revision as of 15:55, 26 May 2015
Save all user's preferences to specified storage.
Syntax
HRESULT SaveUserSettings([in] IUnknown* pUserSettingsDest,
[in, defaultvalue(0)] LONG nFlags);
Parameters
- pUserSettingsDest
- [in] A pointer to IAFS_Name/IAFS_File/IStream 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\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.
