IWbemObjectSink

IWbemObjectSink インターフェイスは、WMI プログラミングモデル内のあらゆる種類の通知を受け取ることができるシンクインターフェイスを作成します。

イベントサブスクリプション用のシンク(IWbemObjectSink または IWbemEventSink)を実装する場合、シンクオブジェクトの Indicate メソッドや SetStatus メソッドの中から WMI を呼び出さないでください。たとえば、Indicate の実装内からシンクをキャンセルするために IWbemServices::CancelAsyncCall を呼び出すと、WMI の状態に支障をきたすおそれがあります。イベントサブスクリプションをキャンセルするには、フラグを設定したうえで、別のスレッドまたは別のオブジェクトから IWbemServices::CancelAsyncCall を呼び出してください。オブジェクト、列挙、クエリの取得など、イベントシンクに関連しない実装では、WMI をコールバックしてもかまいません。

イベント通知を配信する WMI のスレッドは、シンクオブジェクトが処理を完了するまで他の作業を行えないため、シンクの実装ではイベント通知を 100 ミリ秒以内に処理してください。通知に大量の処理が必要な場合は、シンク側で内部キューを使用し、別のスレッドに処理を任せることができます。

Examples

次のコード例は、オブジェクトシンクの単純な実装です。このサンプルは、 IWbemServices::ExecQueryAsync または IWbemServices::CreateInstanceEnumAsync と組み合わせて、返されるインスタンスを受け取るために使用できます。

#include <iostream>
#include <wbemidl.h>
#pragma comment(lib, "wbemuuid.lib")

class QuerySink : public IWbemObjectSink
{
    LONG m_lRef;
    bool bDone; 

public:
    QuerySink() { m_lRef = 0; }
   ~QuerySink() { bDone = TRUE; }

    virtual ULONG STDMETHODCALLTYPE AddRef();
    virtual ULONG STDMETHODCALLTYPE Release();        
    virtual HRESULT STDMETHODCALLTYPE 
        QueryInterface(REFIID riid, void** ppv);

    virtual HRESULT STDMETHODCALLTYPE Indicate( 
            /* [in] */
            LONG lObjectCount,
            /* [size_is][in] */
            IWbemClassObject __RPC_FAR *__RPC_FAR *apObjArray
            );
        
    virtual HRESULT STDMETHODCALLTYPE SetStatus( 
            /* [in] */ LONG lFlags,
            /* [in] */ HRESULT hResult,
            /* [in] */ BSTR strParam,
            /* [in] */ IWbemClassObject __RPC_FAR *pObjParam
            );
};


ULONG QuerySink::AddRef()
{
    return InterlockedIncrement(&m_lRef);
}

ULONG QuerySink::Release()
{
    LONG lRef = InterlockedDecrement(&m_lRef);
    if(lRef == 0)
        delete this;
    return lRef;
}

HRESULT QuerySink::QueryInterface(REFIID riid, void** ppv)
{
    if (riid == IID_IUnknown || riid == IID_IWbemObjectSink)
    {
        *ppv = (IWbemObjectSink *) this;
        AddRef();
        return WBEM_S_NO_ERROR;
    }
    else return E_NOINTERFACE;
}


HRESULT QuerySink::Indicate(long lObjCount, IWbemClassObject **pArray)
{
    for (long i = 0; i < lObjCount; i++)
    {
        IWbemClassObject *pObj = pArray[i];

        // ... use the object.

        // AddRef() is only required if the object will be held after
        // the return to the caller.
    }

    return WBEM_S_NO_ERROR;
}

HRESULT QuerySink::SetStatus(
            /* [in] */ LONG lFlags,
            /* [in] */ HRESULT hResult,
            /* [in] */ BSTR strParam,
            /* [in] */ IWbemClassObject __RPC_FAR *pObjParam
        )
{
    printf("QuerySink::SetStatus hResult = 0x%X\n", hResult);
    return WBEM_S_NO_ERROR;
}

通知を提供するために、ソースから呼び出されます。

このメソッドは、メソッド呼び出しの状態を示す HRESULT を返します。次の一覧は、HRESULT に格納される値を示します。

イベントサブスクリプション用のシンク(IWbemObjectSink または IWbemEventSink)を実装する場合、シンクオブジェクトの Indicate メソッドの中から WMI を呼び出さないでください。たとえば、Indicate の実装内から IWbemServices::CancelAsyncCall を呼び出すと、WMI の状態に支障をきたすおそれがあります。イベントサブスクリプションをキャンセルするには、フラグを設定したうえで、別のスレッドまたは別のオブジェクトから IWbemServices::CancelAsyncCall を呼び出してください。オブジェクト、列挙、クエリの取得など、イベントシンクに関連しない実装では、WMI をコールバックしてもかまいません。

イベント通知を配信する WMI のスレッドは、シンクオブジェクトが処理を完了するまで他の作業を行えないため、シンクの実装ではイベント通知を 100 ミリ秒以内に処理してください。通知に大量の処理が必要な場合は、シンク側で内部キューを使用し、別のスレッドに処理を任せることができます。

イベントプロバイダーがイベントを提供するために Indicate を呼び出したとき、その呼び出しが WBEM_E_SERVER_TOO_BUSY で失敗することがあります。プロバイダーは、これに対してイベントを再送出することで対応できます。

通知シーケンスの終了を示すため、またはその他の状態コードをシンクに送るために、ソースから呼び出されます。

このメソッドは、メソッド呼び出しの状態を示す HRESULT を返します。次の一覧は、HRESULT に格納される値を示します。

イベントサブスクリプション用のシンク(IWbemObjectSink または IWbemEventSink)を実装する場合、シンクオブジェクトの SetStatus メソッドの中から WMI を呼び出さないでください。たとえば、SetStatus の実装内から IWbemServices::CancelAsyncCall を呼び出すと、WMI の状態に支障をきたすおそれがあります。イベントサブスクリプションをキャンセルするには、フラグを設定したうえで、別のスレッドまたは別のオブジェクトから IWbemServices::CancelAsyncCall を呼び出してください。オブジェクト、列挙、クエリの取得など、イベントシンクに関連しない実装では、WMI をコールバックしてもかまいません。

イベント通知を配信する WMI のスレッドは、シンクオブジェクトが処理を完了するまで他の作業を行えないため、シンクの実装ではイベント通知を 100 ミリ秒以内に処理してください。通知に大量の処理が必要な場合は、シンク側で内部キューを使用し、別のスレッドに処理を任せることができます。オブジェクト、列挙、クエリの取得など、イベントシンクに関連しない実装では、WMI をコールバックしてもかまいません。

クライアント側の SetStatus 実装を通じて途中経過の状態更新を受け取るには、プロバイダーまたはサービスのメソッドを呼び出す際に WBEM_FLAG_SENT_STATUS を指定する必要があります。正確な状態は、hResult の HIWORD 値と LOWORD 値をそれぞれ調べることで判断できます。LOWORD(hResult)の値にはこれまでに進んだ量が、HIWORD(hResult)の値には全体量が格納されます。

プロバイダーまたはサービスのメソッドを呼び出す際に WBEM_FLAG_SEND_STATUS を指定しない場合、 SetStatus の呼び出しはちょうど 1 回だけ行われることが保証されます。