Skip to content

enum_helper

概述

函数

函数名称说明
asset_type_find_by_value获取资源类型枚值和名称的对应关系。
find_item获取特定枚值和名称的对应关系。
find_item_by_value获取特定枚值和名称的对应关系。
input_type_find获取输入类型值和名称的对应关系。
keys_type_find获取按键值和名称的对应关系。
keys_type_find_by_value获取按键值和名称的对应关系。
keys_type_set_custom_keys设置自定义键值表。

asset_type_find_by_value 函数

  • 函数功能:

获取资源类型枚值和名称的对应关系。

  • 函数原型:
const key_type_value_t* asset_type_find_by_value (uint32_t value);
  • 参数说明:
参数类型说明
返回值const key_type_value_t*返回资源类型枚值和名称的对应关系。
valueuint32_t资源的类型。

find_item 函数

  • 函数功能:

获取特定枚值和名称的对应关系。

  • 函数原型:
const key_type_value_t* find_item (const key_type_value_t* items, uint32_t nr, const char* name);
  • 参数说明:
参数类型说明
返回值const key_type_value_t*返回资源类型枚值和名称的对应关系。
itemsconst key_type_value_t*特定枚举值对应列表。
nruint32_t列表长度。
nameconst char*名称。

find_item_by_value 函数

  • 函数功能:

获取特定枚值和名称的对应关系。

  • 函数原型:
const key_type_value_t* find_item_by_value (const key_type_value_t* items, uint32_t nr, uint32_t value);
  • 参数说明:
参数类型说明
返回值const key_type_value_t*返回资源类型枚值和名称的对应关系。
itemsconst key_type_value_t*特定枚举值对应列表。
nruint32_t列表长度。
valueuint32_t资源的类型。

input_type_find 函数

  • 函数功能:

获取输入类型值和名称的对应关系。

  • 函数原型:
const key_type_value_t* input_type_find (const char* name);
  • 参数说明:
参数类型说明
返回值const key_type_value_t*返回输入类型值和名称的对应关系。
nameconst char*输入类型名。

keys_type_find 函数

  • 函数功能:

获取按键值和名称的对应关系。

  • 函数原型:
const key_type_value_t* keys_type_find (const char* name);
  • 参数说明:
参数类型说明
返回值const key_type_value_t*返回按键值和名称的对应关系。
nameconst char*按键名。

keys_type_find_by_value 函数

  • 函数功能:

获取按键值和名称的对应关系。

  • 函数原型:
const key_type_value_t* keys_type_find_by_value (uint32_t value);
  • 参数说明:
参数类型说明
返回值const key_type_value_t*返回按键值和名称的对应关系。
valueuint32_t按键值。

keys_type_set_custom_keys 函数

  • 函数功能:

设置自定义键值表。

请确保键值表的生命周期在程序运行期一直存在,不要传入局部变量。

  • 函数原型:
ret_t keys_type_set_custom_keys (const key_type_value_t* table, uint32_t nr);
  • 参数说明:
参数类型说明
返回值ret_t返回RET_OK表示成功,否则表示失败。
tableconst key_type_value_t*键值表(NULL清除之前的设置)。
nruint32_t键值表的长度。