EcGetSubscriptionRunTimeStatus 関数 (evcoll.h)

EcGetSubscriptionRunTimeStatus 関数は、サブスクリプションまたはサブスクリプション自体のイベント ソースの実行時状態情報を取得します。 サブスクリプションは、その名前で指定されます。 イベント ソースが NULL の場合は、サブスクリプション全体の状態が取得されます。

構文

BOOL EcGetSubscriptionRunTimeStatus(
  [in]  LPCWSTR                                SubscriptionName,
  [in]  EC_SUBSCRIPTION_RUNTIME_STATUS_INFO_ID StatusInfoId,
  [in]  LPCWSTR                                EventSourceName,
  [in]  DWORD                                  Flags,
  [in]  DWORD                                  StatusValueBufferSize,
  [in]  PEC_VARIANT                            StatusValueBuffer,
  [out] PDWORD                                 StatusValueBufferUsed
);

パラメーター

[in] SubscriptionName

実行時の状態情報を取得するサブスクリプションの名前。

[in] StatusInfoId

サブスクリプションから取得する実行時の状態情報を指定する識別子。 EC_SUBSCRIPTION_RUNTIME_STATUS_INFO_ID列挙の値を指定します。 EcSubscriptionRunTimeStatusEventSources 値を使用して、サブスクリプションに関連付けられているイベント ソースの一覧を取得できます。

[in] EventSourceName

状態を取得するイベント ソースの名前。 各サブスクリプションには、複数のイベント ソースを含めることができます。

[in] Flags

予約済み。 NULL にする必要があります。

[in] StatusValueBufferSize

実行時の状態情報を保持するユーザー指定のバッファーのサイズ。

[in] StatusValueBuffer

実行時の状態情報を保持するユーザー指定のバッファー。 バッファーには、StatusInfoId パラメーターに渡されるEC_SUBSCRIPTION_RUNTIME_STATUS_INFO_ID値に応じて、適切な値が保持されます。

[out] StatusValueBufferUsed

正常に戻ったときに関数によって使用されるユーザー指定のバッファーのサイズ、または関数が ERROR_INSUFFICIENT_BUFFER で失敗したときにプロパティ値を格納するために必要なサイズ。

戻り値

この関数は BOOL を返します。

要件

サポートされている最小のクライアント	Windows Vista
サポートされている最小のサーバー	Windows Server 2008
対象プラットフォーム	Windows
ヘッダー	evcoll.h
Library	Wecapi.lib
[DLL]	Wecapi.dll

関連項目

Windows イベント コレクター関数