GrabBag/SDK/Device/VzNLSDK/Inc/VZNL_ParameterConfig.h
2026-03-17 22:27:58 +08:00

84 lines
2.5 KiB
C

#ifndef __VIZUM_PARAMETER_CONFIG_HEADER__
#define __VIZUM_PARAMETER_CONFIG_HEADER__
#include "VZNL_Export.h"
#include "VZNL_Types.h"
/**
* @brief 读取用户文件列表 当前仅支持智光眼
* @param hDevice 设备Handle
* @param szUserProfileName [out] 获取用户配置名
* @param nProfileCount [out] 获取文件个数
* @return 返回名称个数
*/
VZNLAPI int VzNL_ReadConfigNameList(VZNLHANDLE hDevice, SVzUserConfigInfo sUserConfiginfo[VZ_USERCONFIG_MAX_COUNT],unsigned int *pnCount);
/**
* @brief 保存用户配置(共200个) 当前仅支持智光眼
* @param hDevice 设备Handle
* @param nProfileIdx 文件Index
* @param lpszName 名称
* @param pExtData 额外数据
* @param nDataLength 额外数据大小
*/
VZNLAPI int VzNL_SaveUserConfig(VZNLHANDLE hDevice, const SVzUserConfigInfo sUserConfiginfo, const void* pExtData, unsigned int nDataLength);
/**
* @brief 恢复用户配置(共200个) 当前仅支持智光眼
* @param hDevice 设备Handle
* @param lpszName 名称
* @param ppExtData 额外数据
* @param pnDataLength 额外数据大小
*/
VZNLAPI int VzNL_RestoreUserConfigFromName(VZNLHANDLE hDevice, const char szName[VZ_USERCONFIG_NAME_LENGTH], void** ppExtData, unsigned int* pnDataLength);
/**
* @brief 移除用户配置(共200个) 当前仅支持智光眼
* @param hDevice 设备Handle
* @param lpszName 名称
* @param ppExtData 额外数据
* @param pnDataLength 额外数据大小
*/
VZNLAPI int VzNL_RemoveUserConfigFromName(VZNLHANDLE hDevice, const char szName[VZ_USERCONFIG_NAME_LENGTH]);
/**
* @brief 清除全部用户配置(共200个) 当前仅支持智光眼
* @param hDevice 设备Handle
* @param pnDataLength 额外数据大小
*/
VZNLAPI int VzNL_RemoveAllUserConfig(VZNLHANDLE hDevice);
/**
* @brief 保存用户配置到文件 当前仅支持智光眼
* @param hDevice 设备Handle
* @param lpszFile 文件
* @param pExtData 额外数据
* @param nDataLength 额外数据大小
*/
VZNLAPI int VzNL_SaveUserConfigToFile(VZNLHANDLE hDevice, const char* lpszFile, const void* pExtData, unsigned int nDataLength);
/**
* @brief 恢复用户配置(共200个) 当前仅支持智光眼
* @param hDevice 设备Handle
* @param lpszFile 文件全路径
* @param ppExtData 额外数据
* @param pnDataLength 额外数据大小
*/
VZNLAPI int VzNL_RestoreUserConfigFromFile(VZNLHANDLE hDevice, const char* lpszFile, void** ppExtData, unsigned int* pnDataLength);
/**
* @brief 释放额外数据空间
* @param ppExtData 释放额外数据空间
*/
VZNLAPI int VzNL_ReleaseUserConfigExtData(void** ppExtData);
/**
* @brief 恢复系统默认配置
* @param hDevice 设备Handle
*/
VZNLAPI int VzNL_RestoreDefaultConfig(VZNLHANDLE hDevice, void** ppExtData, unsigned int* pnExtDataLength);
#endif //__VIZUM_PARAMETER_CONFIG_HEADER__