nl::Weave::Support

摘要

类型定义符
MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType) typedef
const char *(*
回调函数的 typedef，该函数返回一个人类可读的以 NULL 结尾的 C 字符串，用于描述与指定配置文件标识符关联的消息类型。
ProfileNameFunct)(uint32_t inProfileId) typedef
const char *(*
回调函数的 typedef，该函数返回一个人类可读的以 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::Support::ProfileStringInfo

与指定的配置文件标识符相关联的回调，用于返回与该配置文件相关联的人类可读支持字符串。

类型定义符

MessageNameFunct

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

回调函数的 typedef，该函数返回一个人类可读的以 NULL 结尾的 C 字符串，用于描述与指定配置文件标识符关联的消息类型。

注册此回调函数后，当需要使用人类可读的以 NULL 结尾的 C 字符串来描述与指定配置文件标识符关联的消息类型时，系统会调用此回调函数。

详细信息
参数
[in] inProfileId
与指定消息类型相关联的个人资料标识符。
[in] inMsgType
要寻找直观易懂的描述性字符串的消息类型。
返回值
指向以 NULL 结尾的 C 字符串（如果找到匹配项）的指针；否则为 NULL。

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

回调函数的 typedef，该函数返回一个人类可读的以 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

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

函数

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

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

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

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

FindProfileStringInfo

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

RemoveProfileStringContext

bool RemoveProfileStringContext(
  ProfileStringContext & inOutContext
)

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

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

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

UnregisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

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

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

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