IWMDMProgress3::Begin3 メソッド (mswmdm.h)

[アーティクル]
08/25/2023

Begin3 メソッドは、Windows Media デバイスマネージャーによって呼び出され、操作が開始されようとしていることを示します。可能な場合は、操作の期間の見積もりが提供されます。このメソッドは IWMDMProgress::Begin を拡張し、イベントの ID (ID) とコマンドのオプションコンテキストへのポインターに追加の入力パラメーターを指定します。操作はイベント ID によって識別されます。メソッドを使用すると、呼び出し元は不透明なデータ構造をアプリケーションに渡すことができます。

構文

HRESULT Begin3(
  [in]      GUID          EventId,
  [in]      DWORD         dwEstimatedTicks,
  [in, out] OPAQUECOMMAND *pContext
);

パラメーター

[in] EventId

開始する操作を識別する GUID 。次の表に、使用可能な値を示します。

Event	説明
SCP_EVENTID_ACQSECURECLOCK	Windows Media デバイスマネージャーは、サーバーからセキュリティで保護されたクロックを取得しています。
SCP_EVENTID_NEEDTOINDIV	デバイスが個別化されています。これは現在使用されていません。
SCP_EVENTID_DRMINFO	このイベント ID は、各ファイルのコンテンツにあるバージョン DRM ヘッダーをアプリケーションに通知するために使用されます。返される OPAQUECOMMAND 構造体には、 guidCommand メンバーが SCP_PARAMID_DRMVERSION に設定されています。さらに、OPAQUECOMMAND は次のいずれかのフラグを指定します。 WMDM_SCP_DRMINFO_NOT_DRMPROTECTED WMDM_SCP_DRMINFO_V1HEADER WMDM_SCP_DRMINFO_V2HEADER
EVENT_WMDM_CONTENT_TRANSFER	コンテンツはデバイス間で転送中です。

[in] dwEstimatedTicks

操作の完了に必要なティックの推定数を指定する DWORD。 dwEstimatedTicks で渡されるティックの数は、操作を完了するために必要なティック数の推定値です。操作の実行中に Progress3 メソッドが呼び出され、発生したティックの数が示されます。アプリケーションでは、見積もりを使用して、進行状況を示す表示メカニズムを構成できます。

[in, out] pContext

Windows Media デバイスマネージャーによって処理されずにデバイスに送信されるコマンドを含む OPAQUECOMMAND 構造体へのポインター。このパラメーターは省略可能であり、 NULL にすることができます。

戻り値

アプリケーションは、次のいずれかの HRESULT 値を返す必要があります。

リターンコード	説明
S_OK	操作は続行する必要があります。
WMDM_E_USER_CANCELLED	Windows Media デバイスマネージャーでは、完了するまで待たずに現在の操作を取り消す必要があります。アプリケーションがブロックモードを使用している場合、Windows Media デバイスマネージャーはこのエラーをアプリケーションに返します。

注釈

アプリケーションは、操作を続行する必要があることを示すS_OKを返し、操作を取り消す必要があることを示すWMDM_E_USER_CANCELLED。アプリケーションがブロックモードを使用していて、WMDM_E_USER_CANCELLEDを返す場合、Windows Media デバイスマネージャーはこの同じエラーをアプリケーションに返します。

例

次の C++ コードは、 Begin3 の実装例を示しています。


HRESULT Begin3(GUID  EventId, DWORD  dwEstimatedTicks, OPAQUECOMMAND*  pContext)
{
    WCHAR strGuid[64];
    StringFromGUID2(reinterpret_cast<GUID&>(EventId),(LPOLESTR)strGuid, 64);
    // TODO: Display the message "IWMDMProgress3::Begin3 called." 
    // followed by the strGuid value.
    return S_OK;
}