CameraControl.SaveSettingsToRegistry(String) Method

Saves the video settings of the currently used capture device to the system registry.

Namespace: DevExpress.XtraEditors.Camera

Assembly: DevExpress.XtraEditors.v24.2.dll

Declaration

C#

public virtual bool SaveSettingsToRegistry(
    string path
)

VB.NET

Public Overridable Function SaveSettingsToRegistry(
    path As String
) As Boolean

Parameters

Name	Type	Description
path	String	A String value specifying the system registry path to which the video settings are saved.

Returns

Type	Description
Boolean	true if the operation is successfully completed; otherwise, false.

Remarks

Use the SaveSettingsToRegistry method to save the video settings (see CameraControl.VideoSettings) of the currently used device (see CameraControl.Device) to the system registry. The settings can then be restored via the CameraControl.RestoreSettingsFromRegistry method.

For the path parameter you can define whole and partial registry keys. For example, if you define “Software\Company", the full path will be as follows: “HKEY_CURRENT_USER\Software\Company". To store the settings in a different root key, define the entire path in the following form “HKEY_LOCAL_MACHINE\Software\Company".

The values of the following video properties are preserved:

• CameraDeviceBase.Name—Gets the UI display name of the video capture device.
• CameraDeviceBase.Resolution—Gets or sets the resolution of a video stream captured by the current device.
• DeviceVideoSettings.BacklightCompensation—Provides access to the video property that specifies the backlight compensation setting.
• DeviceVideoSettings.Brightness—Provides access to the video property that specifies the brightness, also called the black level.
• DeviceVideoSettings.ColorEnable—Provides access to the video property that specifies the color enable setting.
• DeviceVideoSettings.Contrast—Provides access to the video property that specifies the contrast.
• DeviceVideoSettings.Gain—Provides access to the video property that specifies the gain adjustment.
• DeviceVideoSettings.Gamma—Provides access to the video property that specifies the gamma.
• DeviceVideoSettings.Hue—Provides access to the video property that specifies the hue.
• DeviceVideoSettings.Saturation—Provides access to the video property that specifies the saturation.
• DeviceVideoSettings.Sharpness—Provides access to the video property that specifies the sharpness.
• DeviceVideoSettings.WhiteBalance—Provides access to the video property that specifies the white balance, as a color temperature in degrees Kelvin.

You can also save settings to a file in XML format using the CameraControl.SaveSettingsToXml method.