nl::Weave::支持

摘要

类型定义符
MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType) typedef
const char *(*
回调函数的类型定义符，其返回以可人工读取的 NULL 结尾的 C 字符串，描述与指定个人资料标识符相关联的消息类型。
ProfileNameFunct)(uint32_t inProfileId) typedef
const char *(*
回调函数的类型定义符，该函数返回一个以可人工读取的 NULL 结尾的 C 字符串，描述具有指定配置文件标识符的配置文件。
StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode) typedef
const char *(*
回调函数的 Typedef，该函数会返回人类可读的、以 NULL 结尾的 C 字符串，该字符串描述与指定个人资料标识符相关联的状态代码。

变量
sProfileStringContextHead
注册表的单链列表头指针。

函数
FindProfileStringContext(const ProfileStringContext & inContext)
根据与上下文关联的配置文件标识符，查找支持与指定上下文匹配的上下文的字符串。
FindProfileStringInfo(uint32_t inProfileId)
NL_DLL_EXPORT const ProfileStringInfo *
如果已注册，则配置文件字符串支持与指定的配置文件标识符相关联的回调。
InsertProfileStringContext(ProfileStringContext & inOutContext)
bool
将指定的配置文件字符串支持上下文插入到注册表中。
RegisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
注册提供的配置文件字符串支持回调。
RemoveProfileStringContext(ProfileStringContext & inOutContext)
bool
从注册表中移除指定的配置文件字符串支持上下文。
UnregisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
取消注册提供的配置文件字符串支持回调。

结构体
nl::Weave::Support::ProfileStringContext

用于注册和取消注册与指定个人资料标识符相关联的回调的上下文，用于返回与个人资料关联的简单易懂的支持字符串。
nl::Weave::支持::ProfileStringInfo

与指定个人资料标识符相关联的回调，用于返回与个人资料关联的简单易懂的支持字符串。

类型定义符

消息名称功能

const char *(* MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType)

回调函数的类型定义符，其返回以可人工读取的 NULL 结尾的 C 字符串，描述与指定个人资料标识符相关联的消息类型。

当注册后，当需要用户可读的、以 NULL 结尾的 C 字符串来描述与指定个人资料标识符相关联的消息类型时，就会调用此回调。

详细信息
参数
[in] inProfileId
与指定消息类型关联的个人资料标识符。
[in] inMsgType
用户希望读取的描述性字符串的消息类型。
返回值
找到匹配项时以 NULL 结尾的 C 字符串的指针；否则，返回 NULL。

个人资料名称

const char *(* ProfileNameFunct)(uint32_t inProfileId)

回调函数的类型定义符，该函数返回一个以可人工读取的 NULL 结尾的 C 字符串，描述具有指定配置文件标识符的配置文件。

当注册此回调时，当需要使用人类可读的 NULL 终止的 C 字符串来描述具有指定配置文件标识符的配置文件时，系统会调用此回调。

详细信息
参数
[in] inProfileId
用户能看懂的描述性字符串对应的配置文件标识符。
返回值
找到匹配项时以 NULL 结尾的 C 字符串的指针；否则，返回 NULL。

StatusReportFormatStringFunct

const char *(* StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode)

回调函数的 Typedef，该函数会返回人类可读的、以 NULL 结尾的 C 字符串，该字符串描述与指定个人资料标识符相关联的状态代码。

当注册此回调时，当需要人类可读的、以 NULL 结尾的 C 字符串来描述与指定个人资料标识符相关联的状态代码时，就会调用此回调。

详细信息
参数
[in] inProfileId
与指定状态代码相关联的配置文件标识符。
[in] inStatusCode
用户能看懂的描述性字符串的状态代码。
返回值
找到匹配项时以 NULL 结尾的 C 字符串的指针；否则，返回 NULL。

变量

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

注册表的单链列表头指针。

函数

查找个人资料字符串上下文

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

根据与上下文关联的配置文件标识符，查找支持与指定上下文匹配的上下文的字符串。

此函数根据与上下文关联的配置文件标识符，查找与指定上下文匹配的上下文字符串。

详细信息
参数
[in] inContext
对配置文件字符串的只读引用支持要查找的上下文。
返回值
如果找到，则指向配置文件字符串的只读指针支持上下文；否则，为 NULL。

查找个人资料字符串信息

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

如果已注册，则配置文件字符串支持与指定的配置文件标识符相关联的回调。

详细信息
参数
[in] inProfileId
查找字符串支持回调的配置文件标识符。
返回值
如果找到指向配置文件字符串的只读指针，则支持回调；否则，返回 NULL。
另请参阅：
RegisterProfielStringInfo
UnregisterProfielStringInfo

InsertProfileStringContext

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

将指定的配置文件字符串支持上下文插入到注册表中。

此函数根据升序排列标识符，按照排序顺序将指定的配置文件字符串支持上下文插入到注册表（如果不存在）。

详细信息
参数
[in,out] inOutContext
对配置文件字符串的支持将插入注册表中的上下文。当注册表中存在相关上下文时，mNext 字段可能会在插入或移除其他上下文时进行修改。
返回值
如果插入了上下文，则为 true；否则为 false。

RegisterProfileStringInfo 类中的方法

NL_DLL_EXPORT WEAVE_ERROR RegisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

注册提供的配置文件字符串支持回调。

此函数将注册并提供所提供的个人资料字符串支持回调。

详细信息
参数
[in,out] inOutContext
对配置文件字符串的支持上下文将被注册并添加到注册表中。注册上下文时，系统可能会修改其他 mNext 字段或取消注册其他上下文，因此可能会修改此字段。
返回值
WEAVE_NO_ERROR
成功时。
WEAVE_ERROR_PROFILE_STRING_CONTEXT_ALREADY_REGISTERED
上下文是否已注册。
另请参阅：
FindStringProfileInfo
UnregisterProfielStringInfo

移除个人资料字符串上下文

bool RemoveProfileStringContext(
  ProfileStringContext & inOutContext
)

从注册表中移除指定的配置文件字符串支持上下文。

此函数根据配置文件标识符从注册表中移除指定的配置文件字符串支持上下文（如果存在）。

详细信息
参数
[in,out] inOutContext
对配置文件字符串的支持将被移除（如果存在的话）。移除上下文后，可以修改 mNext 字段。
返回值
如果移除了上下文，则为 true；否则为 false。

取消注册个人资料字符串信息

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

取消注册提供的配置文件字符串支持回调。

此函数取消注册，因此提供的配置文件字符串支持回调不可用。

详细信息
参数
[in,out] inOutContext
对配置文件字符串的引用支持将取消注册、注册后并从注册表中移除的上下文。当上下文未注册时，mNext 字段可以修改。
返回值
WEAVE_NO_ERROR
成功时。
WEAVE_ERROR_PROFILE_STRING_CONTEXT_NOT_REGISTERED
上下文是否已注册。
另请参阅：
FindStringProfileInfo
RegisterProfielStringInfo