nl::Weave::Support

概要

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

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

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

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

指定されたプロファイル識別子を持つプロファイルを説明する、人間が読み取れる NULL 終了 C 文字列を返すコールバック関数の Typedef。

このコールバックは、登録されると、指定されたプロファイル識別子を持つプロファイルを記述するために、人が読める NULL 終了 C 文字列が必要な場合に呼び出されます。

詳細
パラメータ
[in] inProfileId
人が読める説明文字列が検索されるプロファイル ID。
戻り値
一致するものが見つかった場合は、NULL で終了する C 文字列へのポインタ。それ以外の場合は NULL。

StatusReportFormatStringFunct

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

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

このコールバックは、登録されると、指定したプロファイル識別子に関連付けられたステータス コードを記述するために、人が読める 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