Control General Setting File¶
ControlGeneralSettingFile¶
- Overview
Control General Setting File.
Definition
CrError ControlGeneralSettingFile(CrDeviceHandle deviceHandle, CrGeneralSettingControlType controlType, CrChar* fileName);
Input Parameters
Type |
Explanation |
|---|---|
CrDeviceHandle |
deviceHandle
The handle of the connected camera is returned in the variable. This must be set 0 before calling Connect().
|
CrGeneralSettingControlType |
controlType
- CrGeneralSettingControlType_CheckGeneralSettings
Select this type if you want to check which settings will change in the setting file.
- CrGeneralSettingControlType_SetOfGeneralSettings
Select this type if you want to apply the settings in the setting file.
|
CrChar* |
fileName
Path of the GeneralSettingFile to be uploaded.
For the specifications of the setting file, please refer to the Tips section, CameraSetting File
|
- Output parameters
None
Return value
Type |
Explanation |
|---|---|
CrError |
CrError_None on Success
Other than errors above, see Status code & Error
|
- Related API
Special note (details)
ControlGeneralSettingFile can be obtained only when the device property CrDeviceProperty_ControlGeneralSettingFileEnableStatus is Enabled.
RequestControlGeneralSettingResultFile¶
- Overview
Request the result file generated by ControlGeneralSettingFile.
Definition
CrError RequestControlGeneralSettingResultFile(CrDeviceHandle deviceHandle, CrGeneralSettingControlType controlType);
Input Parameters
Type |
Explanation |
|---|---|
CrDeviceHandle |
deviceHandle
The handle of the connected camera is returned in the variable. This must be set 0 before calling Connect().
|
CrGeneralSettingControlType |
controlType
- CrGeneralSettingControlType_CheckGeneralSettings
Select this type to retrieve the result after executing ControlGeneralSettingFile with CrGeneralSettingControlType_CheckGeneralSettings.
- CrGeneralSettingControlType_SetOfGeneralSettings
Select this type to retrieve the result after executing ControlGeneralSettingFile with CrGeneralSettingControlType_SetOfGeneralSettings.
|
- Output parameters
None
Return value
Type |
Explanation |
|---|---|
CrError |
CrError_None on Success
Other than errors above, see Status code & Error
|
- Related API
Special note (details)
Execute this function after receiving OnWarningExt callback with CrWarningExtParam_ControlGeneralSettingFile_OK following ControlGeneralSettingFile execution.When the file is ready, the result will be notified via CrWarningExt_RequestControlGeneralSettingResultFile. Once notified, use GetControlGeneralSettingResultFile to retrieve the file.
GetControlGeneralSettingResultFile¶
- Overview
Get the result file generated by ControlGeneralSettingFile. You can call this function after receiving the CrWarningExt_RequestControlGeneralSettingResultFile notification.
Definition
CrError GetControlGeneralSettingResultFile(CrDeviceHandle deviceHandle, CrInt8u* resultData, CrInt32u* resultDataSize);
Input Parameters
Type |
Explanation |
|---|---|
CrDeviceHandle |
deviceHandle
The handle of the connected camera is returned in the variable. This must be set 0 before calling Connect().
|
Output parameters
Type |
Explanation |
|---|---|
CrInt8u* |
resultData
The buffer to receive the result data.
For the specifications of the setting result file, please refer to the Tips section, CameraSetting File
|
CrInt32u* |
resultDataSize
The size of the buffer allocated by the caller for resultData.
|
Return value
Type |
Explanation |
|---|---|
CrError |
CrError_None on Success
Other than errors above, see Status code & Error
|
- Related API
- Special note (details)
None in particular