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 會傳回使用者可理解的 NULL 結尾的 C 字串，描述具有指定設定檔 ID 的個人資料。
StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode) typedef
const char *(*
回呼函式的 Typedef 會傳回使用者可理解的 NULL 結束字詞 C 字串，說明與指定設定檔 ID 相關聯的狀態碼。

Variables
sProfileStringContextHead
註冊資料庫單獨連結的清單標題指標。

函式
FindProfileStringContext(const ProfileStringContext & inContext)
根據與內容相關聯的個人資料 ID，尋找與指定結構定義相符的個人資料字串。
FindProfileStringInfo(uint32_t inProfileId)
NL_DLL_EXPORT const ProfileStringInfo *
Find (如果已登錄) 設定檔字串支援與指定設定檔 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
取消註冊提供的設定檔字串支援回呼。

結構
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。

Variables

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

註冊資料庫單獨連結的清單標題指標。

函式

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

根據與內容相關聯的個人資料 ID，尋找與指定結構定義相符的個人資料字串。

這個函式會根據與背景資訊相關聯的個人資料 ID，找出與指定結構定義相符的個人資料字串。

詳細說明
參數
[in] inContext
對設定檔字串支援結構定義的唯讀參照。
傳回
設定檔字串的唯讀指標 (如有找到) 支援背景資訊，否則為 NULL。

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

Find (如果已登錄) 設定檔字串支援與指定設定檔 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