IWMDMDeviceSession
COM公式ドキュメント
IWMDMDeviceSession インターフェイスは、複数の操作を 1 つのセッションにまとめることで、デバイス操作の効率を向上させます。
メソッド 2
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
BeginSession メソッドは、デバイスセッションを開始します。
| type | WMDM_SESSION_TYPE | in | 開始するセッションの種類を示す WMDM_SESSION_TYPE。WMDM_SESSION_NONE 以外の任意の値のビット単位の OR を指定します。EndSession でも同じ種類 (または種類の組み合わせ) を指定する必要があります。 |
| pCtx | BYTE* | inoptional | アプリケーションとサービスプロバイダーの間でプライベートな通信を行うための、呼び出し元が確保したセッションコンテキストバッファーへの省略可能なポインター。基となるサービスプロバイダーの仕様を把握しているアプリケーションは、このバッファーを使用してコンテキスト固有のデータを渡すことができます。Windows Media Device Manager はこのコンテキストに対して何も行いません。このバッファーの解放は呼び出し元の責任です。 |
| dwSizeCtx | DWORD | in | コンテキストバッファーのサイズ (バイト単位)。サイズが 0 の場合、pCtx は無視されます。サイズが 0 以外の場合、pCtx は有効なポインターである必要があります。 |
戻り値
このメソッドは HRESULT を返します。Windows Media Device Manager のすべてのインターフェイスメソッドは、次のいずれかの種類のエラーコードを返す可能性があります。
- 標準の COM エラーコード
- HRESULT 値に変換された Windows エラーコード
- Windows Media Device Manager のエラーコード
解説(Remarks)
複数の操作を 1 つのセッションにまとめても、すべての動作が延期されてまとめて実行されるわけではありません。すべての動作 (Insert の呼び出しなど) は、呼び出された時点で引き続き同期的に実行されます。セッションを使用する目的は、Windows Media Device Manager のコンポーネント (セキュアコンテンツプロバイダーやサービスプロバイダーなど) が一部の操作をセッションごとに 1 回だけ実行できるようにし、パフォーマンスを向上させることにあります。たとえば、デバイスへのファイル転送中に、セキュアコンテンツプロバイダーはデバイス証明書をファイル転送ごとではなく、セッションの開始時に 1 回だけ取得できます。
アプリケーションは、一連の操作を行う前に Windows Media Device Manager のデバイスオブジェクトに対して BeginSession を呼び出し、完了したら EndSession を呼び出すことができます。
アプリケーションは通常、複数のファイル転送や削除を行う際に BeginSession を呼び出します。これに応じて、Windows Media Device Manager はセキュアコンテンツプロバイダーおよびサービスプロバイダーに対して BeginSession または EndSession を呼び出します。それを受けて、セキュアコンテンツプロバイダーとサービスプロバイダーは、セッションごとに 1 回だけ必要な処理を実行できます。これらのコンポーネントのいずれかでセッションの開始に失敗した場合、Windows Media Device Manager はそのコンポーネントが返したエラーを返します。
セッションはデバイス単位で実装されています。異なるデバイス上のセッションが互いに干渉することはありません。
セッションには次の制限があります。
- 特定のデバイスに対して同時にアクティブにできるセッションは 1 つだけです。1 つのデバイスで複数のセッションを開こうとするとエラーになります。
-
セッションの種類は組み合わせられます。BeginSession と EndSession では同じフラグの組み合わせを指定する必要があります。したがって、セッションの一部だけを終了することはできません。
たとえば、BeginSession を次の値で呼び出した場合
WMDM_SESSION_TRANSFER_TO_DEVICE | WMDM_SESSION_DELETE
EndSession も次の値で呼び出す必要があります。
WMDM_SESSION_TRANSFER_TO_DEVICE | WMDM_SESSION_DELETE
そうしない場合、Windows Media Device Manager は E_INVALIDARG を返します。
- Windows Media Device Manager のセッションは最適化のための単なる囲い込み機構であり、デバイスのロックや所有権に関する意味を持ちません。異なる Windows Media Device Manager アプリケーションから発生し得るデバイスアクセスの同期は、引き続きサービスプロバイダーまたは下位のデバイスドライバーで行う必要があります。
例
次の C++ コードは、セッションを使用してデバイスへの Insert3 呼び出しをまとめる方法を示しています。このコードは、ベクターに格納された複数のファイルをループで処理し、デバイスに送信します。
// セッションインターフェイスを取得します。
CComQIPtr<IWMDMDeviceSession> pSession(pDevice);
if (pDevice == NULL)
{
// TODO: IWMDMDeviceSession インターフェイスを取得できなかったことを示す
// メッセージを表示します。
return E_NOINTERFACE;
}
// セッションを開始します。カスタムバッファーは使用しません。
hr = pSession->BeginSession(WMDM_SESSION_TRANSFER_TO_DEVICE, NULL, NULL);
if (hr != S_OK)
{
// TODO: セッションの開始に失敗したことを示すメッセージを表示します。
return hr;
}
else
{
// TODO: セッションが開始したことを示すメッセージを表示します。
}
// ファイルを挿入します。これらの呼び出しは同期的に行われます。
UINT flags = WMDM_MODE_BLOCK | WMDM_STORAGECONTROL_INSERTINTO | WMDM_FILE_CREATE_OVERWRITE | WMDM_CONTENT_FILE;
CComPtr<IWMDMStorage> pNewStorage;
for(int i = 0; i < sourceFiles.size(); i++)
{
hr = pStorageControl3->Insert3(
flags,
WMDM_FILE_ATTR_FOLDER,
sourceFiles[i],
NULL, // 既定の名前を使用します。
NULL, // IWMDMOperation は指定しません。
NULL, // IWMDMProgress は指定しません。
NULL, // メタデータは指定しません。
NULL, // SCP に送るものはありません。
&pNewStorage);
if (pNewStorage != NULL)
pNewStorage.Release();
CHECK_HR(hr, "Sent file " << sourceFiles[i] << " to the device.", "Couldn't send file " << sourceFiles[i] << " to the device");
}
// セッションを閉じます。
hr = pSession->EndSession(WMDM_SESSION_TRANSFER_TO_DEVICE, NULL, NULL);
CHECK_HR(hr,"Closed the session.","Couldn't close the session.");
EndSession メソッドは、デバイスセッションを終了します。
| type | WMDM_SESSION_TYPE | in | 終了するセッションの種類を示す WMDM_SESSION_TYPE。BeginSession で指定した値のビット単位の OR と同じものを指定する必要があります。 |
| pCtx | BYTE* | inoptional | アプリケーションとサービスプロバイダーの間でプライベートな通信を行うための、呼び出し元が確保したセッションコンテキストバッファーへの省略可能なポインター。基となるサービスプロバイダーの仕様を把握しているアプリケーションは、このバッファーを使用してコンテキスト固有のデータを渡すことができます。Windows Media Device Manager はこのコンテキストに対して何も行いません。このバッファーの解放は呼び出し元の責任です。 |
| dwSizeCtx | DWORD | in | コンテキストバッファーのサイズ (バイト単位)。サイズが 0 の場合、pCtx は無視されます。サイズが 0 以外の場合、pCtx は有効なポインターである必要があります |
戻り値
このメソッドは HRESULT を返します。Windows Media Device Manager のすべてのインターフェイスメソッドは、次のいずれかの種類のエラーコードを返す可能性があります。
- 標準の COM エラーコード
- HRESULT 値に変換された Windows エラーコード
- Windows Media Device Manager のエラーコード
解説(Remarks)
セッションはデバイスに対する一連の操作を囲い込み、Windows Media Device Manager のコンポーネントが共通のセットアップ処理や終了処理を個々の転送ごとではなく 1 回だけ実行することで、パフォーマンスを最適化できるようにします。詳細については BeginSession を参照してください。
EndSession の呼び出しに応じて、Windows Media Device Manager はセキュアコンテンツプロバイダーおよびサービスプロバイダーに対して EndSession を呼び出します。いずれかで呼び出しが失敗した場合、Windows Media Device Manager はエラーを返します。その場合でも、いずれかのコンポーネントでは EndSession が成功している可能性があります。
例
次の C++ コードは、セッションを使用してデバイスへの Insert3 呼び出しをまとめる方法を示しています。このコードは、ベクターに格納された複数のファイルをループで処理し、デバイスに送信します。
// セッションインターフェイスを取得します。
CComQIPtr<IWMDMDeviceSession> pSession(pDevice);
if (pDevice == NULL)
{
// TODO: アプリケーションが IWMDMDeviceSession インターフェイスを取得できなかったことを示すメッセージを表示します。
return E_NOINTERFACE;
}
// セッションを開始します。カスタムバッファーは使用しません。
hr = pSession->BeginSession(WMDM_SESSION_TRANSFER_TO_DEVICE, NULL, NULL);
if (hr != S_OK)
{
/ /TODO: セッションの開始に失敗したことを示すメッセージを表示します。
return hr;
}
else
{
// TODO: セッションが開始したことを示すメッセージを表示します。
}
// ファイルを挿入します。これらの呼び出しは同期的に行われます。
UINT flags = WMDM_MODE_BLOCK | WMDM_STORAGECONTROL_INSERTINTO | WMDM_FILE_CREATE_OVERWRITE | WMDM_CONTENT_FILE;
CComPtr<IWMDMStorage> pNewStorage;
for(int i = 0; i < sourceFiles.size(); i++)
{
hr = pStorageControl3->Insert3(
flags,
WMDM_FILE_ATTR_FOLDER,
sourceFiles[i],
NULL, // 既定の名前を使用します。
NULL, // IWMDMOperation は指定しません
NULL, // IWMDMProgress は指定しません
NULL, // メタデータは指定しません
NULL, // SCP に送るものはありません。
&pNewStorage);
if (pNewStorage != NULL)
pNewStorage.Release();
CHECK_HR(hr, "Sent file " << sourceFiles[i] << " to the device.", "Couldn't send file " << sourceFiles[i] << " to the device");
}
// セッションを閉じます。
hr = pSession->EndSession(WMDM_SESSION_TRANSFER_TO_DEVICE, NULL, NULL);
CHECK_HR(hr,"Closed the session.","Couldn't close the session.");
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IWMDMDeviceSession "{82AF0A65-9D96-412C-83E5-3C43E4B06CC7}" #usecom global IWMDMDeviceSession IID_IWMDMDeviceSession "{}" #comfunc global IWMDMDeviceSession_BeginSession 3 int,var,int #comfunc global IWMDMDeviceSession_EndSession 4 int,var,int ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IWMDMDeviceSession "{82AF0A65-9D96-412C-83E5-3C43E4B06CC7}" #usecom global IWMDMDeviceSession IID_IWMDMDeviceSession "{}" #comfunc global IWMDMDeviceSession_BeginSession 3 int,sptr,int #comfunc global IWMDMDeviceSession_EndSession 4 int,sptr,int ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。