nl::Weave::Support

概要

Typedef
MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType) typedef
const char *(*
指定されたプロファイル識別子に関連付けられたメッセージ タイプを表す、人が読める形式の NULL で終わる C 文字列を返すコールバック関数の Typedef。
ProfileNameFunct)(uint32_t inProfileId) typedef
const char *(*
指定されたプロファイル ID を持つプロファイルを記述する、人が読める形式の NULL 終了の C 文字列を返すコールバック関数の Typedef。
StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode) typedef
const char *(*
指定されたプロファイル ID に関連付けられたステータス コードを表す、人が読める形式の NULL 終了の C 文字列を返すコールバック関数の Typedef。

変数
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::Support::ProfileStringContext

指定されたプロファイル ID に関連付けられたコールバックを登録および登録解除するためのコンテキスト。プロファイルに関連付けられたサポート文字列を人が読める形式で返すことができます。
nl::Weave::Support::ProfileStringInfo

指定されたプロファイル ID に関連付けられたコールバック。人が読める形式の、プロファイルに関連付けられたサポート文字列を返します。

Typedef

MessageNameFunct

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

指定されたプロファイル識別子に関連付けられたメッセージ タイプを表す、人が読める形式の NULL で終わる C 文字列を返すコールバック関数の Typedef。

このコールバックは登録時に、指定されたプロファイル識別子に関連付けられたメッセージ タイプを記述するために、人が読める形式の NULL で終わる C 文字列が必要な場合に呼び出されます。

詳細
パラメータ
[in] inProfileId
指定されたメッセージ タイプに関連付けられたプロファイル ID。
[in] inMsgType
人が読める形式の説明文字列を求めるメッセージ タイプ。
戻り値
一致が見つかった場合は、NULL で終わる C 文字列へのポインタ。それ以外の場合は NULL を返します。

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

指定されたプロファイル ID を持つプロファイルを記述する、人が読める形式の NULL 終了の C 文字列を返すコールバック関数の Typedef。

このコールバックは登録時に、指定されたプロファイル ID でプロファイルを記述するために、人間が読み取れる NULL で終わる C 文字列が必要な場合に呼び出されます。

詳細
パラメータ
[in] inProfileId
人間が読み取れる記述文字列を求めるプロファイル ID。
戻り値
一致が見つかった場合は、NULL で終わる C 文字列へのポインタ。それ以外の場合は NULL を返します。

StatusReportFormatStringFunct

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

指定されたプロファイル ID に関連付けられたステータス コードを表す、人が読める形式の NULL 終了の C 文字列を返すコールバック関数の Typedef。

このコールバックは登録時に、指定されたプロファイル ID に関連付けられたステータス コードの説明のために、人が読める形式の NULL で終わる C 文字列が必要な場合に呼び出されます。

詳細
パラメータ
[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