nl::Weave::Support

摘要

Typedefs
MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType) typedef
const char *(*
回呼函式的 Typedef 會傳回使用者可理解的 NULL 結尾 C 字串，說明與指定設定檔 ID 相關聯的訊息類型。
ProfileNameFunct)(uint32_t inProfileId) typedef
const char *(*
回呼函式的 Typedef 會傳回人類可讀的 C 字串 (以 NULL 結尾)，說明具有指定設定檔 ID 的設定檔。
StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode) typedef
const char *(*
回呼函式的 Typedef 會傳回使用者可理解的 NULL 結尾 C 字串，說明與指定設定檔 ID 相關聯的狀態碼。

變數
sProfileStringContextHead
登錄專用清單標頭指標。

函式
FindProfileStringContext(const ProfileStringContext & inContext)
根據與情境相關聯的個人資料 ID，尋找可提供與指定背景資訊相符的個人資料字串。
FindProfileStringInfo(uint32_t inProfileId)
NL_DLL_EXPORT const ProfileStringInfo *
如果設定檔字串已註冊，則設定檔字串支援與指定設定檔 ID 相關聯的回呼。
InsertProfileStringContext(ProfileStringContext & inOutContext)
bool
在登錄檔中插入指定的設定檔字串支援背景資訊。
RegisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
註冊提供的設定檔字串支援回呼。
RemoveProfileStringContext(ProfileStringContext & inOutContext)
bool
從登錄檔中移除指定的設定檔字串支援結構定義。
UnregisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
取消註冊提供的設定檔字串支援回呼。

Structs
nl::Weave::Support::ProfileStringContext

如何註冊及取消註冊與指定設定檔 ID 相關聯的回呼，以傳回與設定檔相關聯的人類可讀支援字串。
nl::Weave::Support::ProfileStringInfo

與指定設定檔 ID 相關聯的回呼，用於傳回與設定檔相關聯的人類可讀支援字串。

Typedefs

MessageNameFunct

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

回呼函式的 Typedef 會傳回使用者可理解的 NULL 結尾 C 字串，說明與指定設定檔 ID 相關聯的訊息類型。

註冊時，需要以使用者可理解的 NULL 結尾 C 字串來描述與指定設定檔 ID 相關聯的訊息類型時，就會叫用此回呼。

詳細資料
參數
[in] inProfileId
與指定訊息類型相關聯的個人資料 ID。
[in] inMsgType
系統尋找使用者可理解的描述性字串訊息類型。
傳回
指向以 NULL 結尾的 C 字串表示的相符項目；否則為 NULL。

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

回呼函式的 Typedef 會傳回使用者可理解的 NULL 結尾 C 字串，用來描述具有指定設定檔 ID 的設定檔。

註冊時，需要以使用者可理解的 NULL 結尾 C 字串來描述具有指定設定檔 ID 的設定檔時，就會叫用此回呼。

詳細資料
參數
[in] inProfileId
需要使用者可理解的描述性字串的個人資料 ID。
傳回
指向以 NULL 結尾的 C 字串表示的相符項目；否則為 NULL。

StatusReportFormatStringFunct

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

回呼函式的 Typedef 會傳回使用者可理解的 NULL 結尾 C 字串，說明與指定設定檔 ID 相關聯的狀態碼。

註冊時，需要以使用者可理解的 NULL 結尾 C 字串來描述與指定設定檔 ID 相關聯的狀態碼時，就會叫用此回呼。

詳細資料
參數
[in] inProfileId
與指定狀態碼相關聯的個人資料 ID。
[in] inStatusCode
系統尋找使用者可理解的描述性字串的狀態碼。
傳回
指向以 NULL 結尾的 C 字串表示的相符項目；否則為 NULL。

變數

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

登錄專用清單標頭指標。

函式

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

根據與情境相關聯的個人資料 ID，尋找可提供與指定背景資訊相符的個人資料字串。

這個函式會根據與上下文相關的個人資料 ID，尋找符合指定情境的個人資料字串。

詳細資料
參數
[in] inContext
設定檔字串支援背景資訊的唯讀參照，支援背景資訊。
傳回
讀取設定檔字串支援背景資訊的唯讀指標 (如果有的話)；否則為 NULL。

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

如果設定檔字串已註冊，則設定檔字串支援與指定設定檔 ID 相關聯的回呼。

詳細資料
參數
[in] inProfileId
設定檔 ID，用來尋找字串支援回呼。
傳回
設定檔字串的唯讀指標支援如果找到回呼，就會支援回呼；否則為 NULL。
另請參閱：
RegisterProfielStringInfo
UnregisterProfielStringInfo

InsertProfileStringContext

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

在登錄檔中插入指定的設定檔字串支援背景資訊。

此函式會根據遞增設定檔 ID，將指定的個人資料字串支援背景資訊插入登錄檔中 (如果尚未提供的話)。

詳細資料
參數
[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
)

從登錄檔中移除指定的設定檔字串支援結構定義。

這個函式會根據設定檔 ID (如有) 從登錄檔中移除指定的設定檔字串支援背景資訊。

詳細資料
參數
[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