nl:: 編織:: 支援
總結
Typedefs |
|
---|---|
MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType)
|
typedefconst char *(*
傳回回呼函式的回呼函式,可傳回使用者可理解的 NULL 結尾 C 字串,用來說明與指定設定檔識別碼相關聯的訊息類型。 |
ProfileNameFunct)(uint32_t inProfileId)
|
typedefconst char *(*
用來為回呼函式傳回類型,用來傳回使用者可理解的 NULL 結尾 C 字串,用來說明設定檔具有指定的設定檔 ID。 |
StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode)
|
typedefconst 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:: |
註冊及取消註冊與指定設定檔 ID 相關聯的回呼,以傳回與設定檔相關聯的使用者可理解支援字串。 |
nl:: |
與指定設定檔 ID 相關聯的回呼,用來傳回與簡介相關的使用者可理解支援字串。 |
Typedefs
MessageNameFunct
const char *(* MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType)
傳回回呼函式的回呼函式,可傳回使用者可理解的 NULL 結尾 C 字串,用來說明與指定設定檔識別碼相關聯的訊息類型。
註冊時,如果要求以使用者可理解的 NULL 結尾 C 字串來描述與指定設定檔識別碼相關聯的訊息類型,就會叫用這個回呼。
詳細資料 | |||||
---|---|---|---|---|---|
參數 |
|
||||
傳回 |
如果找到相符項目,則指向 NULL 結尾 C 字串的指向指標;否則為 NULL。
|
個人資料名稱基金
const char *(* ProfileNameFunct)(uint32_t inProfileId)
用來為回呼函式傳回類型,用來傳回使用者可理解的 NULL 結尾 C 字串,用來說明設定檔具有指定的設定檔 ID。
註冊時,當需要以使用者可理解的 NULL 結尾 C 字串來描述設定檔,以指定設定檔 ID 時,就會叫用這個回呼。
詳細資料 | |||
---|---|---|---|
參數 |
|
||
傳回 |
如果找到相符項目,則指向 NULL 結尾 C 字串的指向指標;否則為 NULL。
|
StatusReportFormatStringFunct
const char *(* StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode)
傳回回呼函式的回呼函式,可傳回使用者可理解的 NULL 結尾 C 字串,用來說明與指定設定檔識別碼相關聯的狀態碼。
註冊時,當需要以使用者可理解的 NULL 結尾 C 字串來描述與指定設定檔識別碼相關聯的狀態碼時,就會叫用這個回呼。
詳細資料 | |||||
---|---|---|---|---|---|
參數 |
|
||||
傳回 |
如果找到相符項目,則指向 NULL 結尾 C 字串的指向指標;否則為 NULL。
|
變數
函式
FindProfileStringContext
ProfileStringContext * FindProfileStringContext( const ProfileStringContext & inContext )
根據與相關內容相關聯的設定檔 ID,找出符合指定情境的設定檔字串。
此函式會根據與背景資訊相關聯的設定檔 ID,找出符合指定內容的設定檔字串支援內容。
詳細資料 | |||
---|---|---|---|
參數 |
|
||
傳回 |
設定檔字串支援唯讀模式 (如果有找到的話);否則為 NULL。
|
尋找設定檔字串資訊
NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo( uint32_t inProfileId )
找到已註冊的個人資料字串時,可尋找與指定設定檔 ID 相關聯的回呼。
詳細資料 | |||
---|---|---|---|
參數 |
|
||
傳回 |
如果有,則指向設定檔字串的唯讀指標支援回呼 (如有)。
|
RegisterProfielStringInfo
UnregisterProfielStringInfo
插入設定檔字串內容
bool InsertProfileStringContext( ProfileStringContext & inOutContext )
將指定的設定檔字串支援內容插入登錄檔。
這個函式會根據指定的設定檔識別碼,以遞增順序將指定的設定檔字串支援內容插入至登錄檔中。
詳細資料 | |||
---|---|---|---|
參數 |
|
||
傳回 |
如果是插入內容,則傳回 true,否則為 false。
|
註冊設定檔字串資訊
NL_DLL_EXPORT WEAVE_ERROR RegisterProfileStringInfo( ProfileStringContext & inOutContext )
註冊提供的設定檔字串支援回呼。
這個函式會登錄並開放使用所提供的設定檔字串支援回呼。
詳細資料 | |||||
---|---|---|---|---|---|
參數 |
|
||||
傳回值 |
|
FindStringProfileInfo
UnregisterProfielStringInfo
移除設定檔字串內容
bool RemoveProfileStringContext( ProfileStringContext & inOutContext )
從登錄檔中移除指定的設定檔字串支援內容。
這個函式會根據設定檔 ID,從登錄項目中移除指定的設定檔字串支援內容 (如有)。
詳細資料 | |||
---|---|---|---|
參數 |
|
||
傳回 |
如果內容遭到移除,則傳回 true,否則為 false。
|
取消註冊註冊字串資訊
NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo( ProfileStringContext & inOutContext )
取消註冊提供的設定檔字串支援回呼。
此函式會取消註冊,且無法使用所提供的設定檔字串支援回呼。
詳細資料 | |||||
---|---|---|---|---|---|
參數 |
|
||||
傳回值 |
|
FindStringProfileInfo
RegisterProfielStringInfo