Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

nl::Weave::サポート

まとめ

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。

Variables

sProfileStringContextHead
レジストリが単独でリンクされたリストヘッド ポインタ。

Functions

FindProfileStringContext(const ProfileStringContext & inContext)
コンテキストに関連付けられたプロファイル識別子に基づいて、指定したコンテキストに一致するプロファイル文字列をサポートするコンテキストを探します。
FindProfileStringInfo(uint32_t inProfileId)
NL_DLL_EXPORT const ProfileStringInfo *
登録されている場合、プロファイル文字列は、指定されたプロファイル識別子に関連付けられたコールバックをサポートします。
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 に関連付けられたコールバックは、そのプロファイルに関連付けられた、人が読めるサポート文字列を返します。

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)

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

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

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

ステータス レポート文字列文字列

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

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

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

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

Variables

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

レジストリが単独でリンクされたリストヘッド ポインタ。

Functions

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

コンテキストに関連付けられたプロファイル識別子に基づいて、指定したコンテキストに一致するプロファイル文字列をサポートするコンテキストを探します。

この関数は、コンテキストに関連付けられたプロファイル ID に基づいて、指定されたコンテキストに一致するプロファイル文字列をサポートするコンテキストを検索します。

詳細
パラメータ
[in] inContext
検索するプロファイル文字列のサポート コンテキストの読み取り専用リファレンス。
戻り値
プロファイル文字列への読み取り専用ポインタ(見つかった場合)またはそれ以外の場合は NULL。

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

登録されている場合、プロファイル文字列は、指定されたプロファイル識別子に関連付けられたコールバックをサポートします。

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