ホーム › Media.DeviceManager › IWMDMLogger

IWMDMLogger

COM

📘 Microsoft Learn (日本語) · English

IID110a3200-5a79-11d3-8d78-444553540000継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IWMDMLogger インターフェイスは、Windows Media Device Manager のアプリケーションおよびサービスプロバイダーが、共通のログファイルにエントリを記録するために使用します。

メソッド 9

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT IsEnabled(BOOL* pfEnabled)

IsEnabled メソッドは、ログ記録が有効かどうかを判定します。

pfEnabled

BOOL*

out

ログ記録が有効な場合に出力として true が設定されるフラグへのポインター。

戻り値

このメソッドは HRESULT を返します。Windows Media Device Manager のすべてのインターフェイスメソッドは、次のいずれかの種類のエラーコードを返す可能性があります。

標準の COM エラーコード
HRESULT 値に変換された Windows エラーコード
Windows Media Device Manager のエラーコード

発生しうるエラーコードの詳細な一覧については、Error Codes を参照してください。

解説(Remarks)

WmdmLog.idl ファイルは、WmdmLog.dll の IDL ソースコードです。このファイルは MIDL ツールによって処理され、タイプライブラリ (WmdmLog.tlb) とマーシャリングコードが生成されます。

例


// ログオブジェクトを作成します。
CoCreateInstance(CLSID_WMDMLogger, NULL, CLSCTX_ALL, __uuidof(IWMDMLogger), (void**)&m_pLogger);
BOOL enabled = FALSE;
hr = m_pLogger->IsEnabled(&enabled);
// TODO: ログ記録が有効か無効かを示すメッセージを表示します。
if(!enabled)
{
    if(m_pLogger->Enable(TRUE) != S_OK)
        m_pLogger = NULL;
}

vtbl 4 HRESULT Enable(BOOL fEnable)

Enable メソッドは、ログ記録を有効または無効にします。既定ではログ記録は有効です。

fEnable

BOOL

true の場合はログ記録を有効にし、false の場合は無効にするフラグ。

戻り値

標準の COM エラーコード
HRESULT 値に変換された Windows エラーコード
Windows Media Device Manager のエラーコード

発生しうるエラーコードの詳細な一覧については、Error Codes を参照してください。

vtbl 5 HRESULT GetLogFileName(LPSTR pszFilename, DWORD nMaxChars)

GetLogFileName メソッドは、現在のログファイルへのフルパスを返します。

pszFilename	LPSTR	out	ログファイル名を受け取るバッファーへのポインター。
nMaxChars	DWORD	in	pszFilename バッファーのサイズを指定します。これは、終端の NULL 文字を含めてバッファーに格納できる最大文字数です。

戻り値

標準の COM エラーコード
HRESULT 値に変換された Windows エラーコード
Windows Media Device Manager のエラーコード

発生しうるエラーコードの詳細な一覧については、Error Codes を参照してください。

解説(Remarks)

既定のログファイルは < Windows ディレクトリ >\System32\Wmdm.log です。

vtbl 6 HRESULT SetLogFileName(LPSTR pszFilename)

SetLogFileName メソッドは、現在のログファイルへのフルパスを設定します。以降のログエントリは、すべてこのファイルに記録されます。

pszFilename

LPSTR

新しいログファイルへのフルパスを示す文字列へのポインター。これはワイド文字の文字列ではないことに注意してください。

戻り値

標準の COM エラーコード
HRESULT 値に変換された Windows エラーコード
Windows Media Device Manager のエラーコード

発生しうるエラーコードの詳細な一覧については、Error Codes を参照してください。

解説(Remarks)

既定のログファイルは < Windows ディレクトリ >\System32\Wmdm.log です。

vtbl 7 HRESULT LogString(DWORD dwFlags, LPSTR pszSrcName, LPSTR pszLog)

LogString メソッドは、現在のログファイルに文字列を記録します。各ログエントリには復帰と改行が追加されます。

dwFlags

DWORD

文字列の記録方法を制御するフラグ。このパラメーターには、次の値の 1 つ以上を組み合わせて指定します。

値	説明
WMDM_LOG_SEV_INFO	ログエントリを情報としてタグ付けします。
WMDM_LOG_SEV_WARN	ログエントリを警告としてタグ付けします。
WMDM_LOG_SEV_ERROR	ログエントリをエラーとしてタグ付けします。
WMDM_LOG_NOTIMESTAMP	ログエントリにタイムスタンプを含めません。タイムスタンプは、タイムゾーン情報を除いた ISO 形式です。

pszSrcName

LPSTR

ログエントリを記録するモジュールの名前を含む文字列へのポインター。このパラメーターには NULL を指定できます。

pszLog

LPSTR

ログにコピーする文字列へのポインター。このパラメーターには NULL を指定できます。

戻り値

標準の COM エラーコード
HRESULT 値に変換された Windows エラーコード
Windows Media Device Manager のエラーコード

発生しうるエラーコードの詳細な一覧については、Error Codes を参照してください。

vtbl 8 HRESULT LogDword(DWORD dwFlags, LPSTR pszSrcName, LPSTR pszLogFormat, DWORD dwLog)

LogDword メソッドは、現在のログファイルに DWORD 値を記録します。各ログエントリには復帰と改行が追加されます。

dwFlags

DWORD

文字列の記録方法を制御するフラグ。このパラメーターには、次の値の 1 つ以上を組み合わせて指定します。

値	説明
WMDM_LOG_SEV_INFO	ログエントリを情報としてタグ付けします。
WMDM_LOG_SEV_WARN	ログエントリを警告としてタグ付けします。
WMDM_LOG_SEV_ERROR	ログエントリをエラーとしてタグ付けします。
WMDM_LOG_NOTIMESTAMP	ログエントリにタイムスタンプを含めません。タイムスタンプは、タイムゾーン情報を除いた ISO 形式です。

pszSrcName

LPSTR

ログエントリを記録するモジュールの名前を含む文字列への省略可能なポインター。

pszLogFormat

LPSTR

ログ文字列の書式を指定する文字列へのポインター。この文字列は、printf 関数の書式文字列と同じ形式です。

dwLog

DWORD

記録する DWORD 値。

戻り値

標準の COM エラーコード
HRESULT 値に変換された Windows エラーコード
Windows Media Device Manager のエラーコード

発生しうるエラーコードの詳細な一覧については、Error Codes を参照してください。

vtbl 9 HRESULT Reset()

Reset メソッドは、現在のログファイルの内容を削除します。

戻り値

標準の COM エラーコード
HRESULT 値に変換された Windows エラーコード
Windows Media Device Manager のエラーコード

発生しうるエラーコードの詳細な一覧については、Error Codes を参照してください。

vtbl 10 HRESULT GetSizeParams(DWORD* pdwMaxSize, DWORD* pdwShrinkToSize)

GetSizeParams メソッドは、現在のログファイルの現在のサイズパラメーターを取得します。

pdwMaxSize	DWORD*	out	ログファイルのおおよその最大サイズを受け取るバッファーへのポインター。このパラメーターには NULL を指定できます。
pdwShrinkToSize	DWORD*	out	ログファイルが最大サイズに達した後に縮小される、おおよそのサイズを受け取るバッファーへのポインター。このパラメーターには NULL を指定できます。

戻り値

標準の COM エラーコード
HRESULT 値に変換された Windows エラーコード
Windows Media Device Manager のエラーコード

発生しうるエラーコードの詳細な一覧については、Error Codes を参照してください。

vtbl 11 HRESULT SetSizeParams(DWORD dwMaxSize, DWORD dwShrinkToSize)

SetSizeParams メソッドは、現在のログファイルの現在のサイズパラメーターを設定します。

dwMaxSize	DWORD	in	ログファイルのおおよその最大サイズ。ログファイルのサイズは各ログエントリを記録する前に確認されます。そのため、次のログエントリが記録されるまでは、ログファイルが最大サイズより大きくなることがあります。
dwShrinkToSize	DWORD	in	ログファイルが最大サイズに達したときに縮小する、おおよそのファイルサイズ。ログエントリの途中でファイルが分割されないように、通常はこの値より少し小さいサイズまで縮小されます。

戻り値

標準の COM エラーコード
HRESULT 値に変換された Windows エラーコード
Windows Media Device Manager のエラーコード

発生しうるエラーコードの詳細な一覧については、Error Codes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IWMDMLogger "{110A3200-5A79-11D3-8D78-444553540000}"
#usecom global IWMDMLogger IID_IWMDMLogger "{110A3202-5A79-11D3-8D78-444553540000}"
#comfunc global IWMDMLogger_IsEnabled       3 var
#comfunc global IWMDMLogger_Enable          4 int
#comfunc global IWMDMLogger_GetLogFileName  5 var,int
#comfunc global IWMDMLogger_SetLogFileName  6 str
#comfunc global IWMDMLogger_LogString       7 int,str,str
#comfunc global IWMDMLogger_LogDword        8 int,str,str,int
#comfunc global IWMDMLogger_Reset           9
#comfunc global IWMDMLogger_GetSizeParams   10 var,var
#comfunc global IWMDMLogger_SetSizeParams   11 int,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IWMDMLogger "{110A3200-5A79-11D3-8D78-444553540000}"
#usecom global IWMDMLogger IID_IWMDMLogger "{110A3202-5A79-11D3-8D78-444553540000}"
#comfunc global IWMDMLogger_IsEnabled       3 sptr
#comfunc global IWMDMLogger_Enable          4 int
#comfunc global IWMDMLogger_GetLogFileName  5 sptr,int
#comfunc global IWMDMLogger_SetLogFileName  6 str
#comfunc global IWMDMLogger_LogString       7 int,str,str
#comfunc global IWMDMLogger_LogDword        8 int,str,str,int
#comfunc global IWMDMLogger_Reset           9
#comfunc global IWMDMLogger_GetSizeParams   10 sptr,sptr
#comfunc global IWMDMLogger_SetSizeParams   11 int,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。