nl::編織：:支援

總結

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

變數
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
取消註冊提供的設定檔字串支援回呼。

結構
nl::Weave:: 支援：:ProfileStringContext

註冊及取消註冊與指定設定檔 ID 相關聯的回呼，以傳回與設定檔相關聯的使用者可理解支援字串。
nl::Weave::支援::ProfileStringInfo

與指定設定檔 ID 相關聯的回呼，用來傳回與簡介相關的使用者可理解支援字串。

Typedefs

MessageNameFunct

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 字串，用來說明設定檔具有指定的設定檔 ID。

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

詳細資料
參數
[in] inProfileId
設定檔 ID，用來尋找使用者可理解的描述性字串。
傳回
如果找到相符項目，則指向 NULL 結尾 C 字串的指向指標；否則為 NULL。

StatusReportFormatStringFunct

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

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

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

詳細資料
參數
[in] inProfileId
與指定狀態碼相關的設定檔識別碼。
[in] inStatusCode
要求取得使用者可理解描述性字串的狀態碼。
傳回
如果找到相符項目，則指向 NULL 結尾 C 字串的指向指標；否則為 NULL。

變數

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

登錄檔的單項清單標頭指標。

函式

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

根據與相關內容相關聯的設定檔 ID，找出符合指定情境的設定檔字串。

此函式會根據與背景資訊相關聯的設定檔 ID，找出符合指定內容的設定檔字串支援內容。

詳細資料
參數
[in] inContext
設定檔設定檔支援內容的唯讀參照要尋找。
傳回
設定檔字串支援唯讀模式 (如果有找到的話)；否則為 NULL。

尋找設定檔字串資訊

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

找到已註冊的個人資料字串時，可尋找與指定設定檔 ID 相關聯的回呼。

詳細資料
參數
[in] inProfileId
這個設定檔 ID 可用來尋找支援字串的回呼。
傳回
如果有，則指向設定檔字串的唯讀指標支援回呼 (如有)。
另請參閱：
RegisterProfielStringInfo
UnregisterProfielStringInfo

插入設定檔字串內容

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

將指定的設定檔字串支援內容插入登錄檔。

這個函式會根據指定的設定檔識別碼，以遞增順序將指定的設定檔字串支援內容插入至登錄檔中。

詳細資料
參數
[in,out] inOutContext
將插入登錄檔的設定檔字串支援內容參照。系統會將登錄檔放在 登錄檔中，但是在插入或移除其他結構定義時，可以修改 mNext 欄位。
傳回
如果是插入內容，則傳回 true，否則為 false。

註冊設定檔字串資訊

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
)

從登錄檔中移除指定的設定檔字串支援內容。

這個函式會根據設定檔 ID，從登錄項目中移除指定的設定檔字串支援內容 (如有)。

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