ホーム › System.ComponentServices › ICrmFormatLogRecords

ICrmFormatLogRecords

COM

📘 Microsoft Learn (日本語) · English

IID9c51d821-c98b-11d1-82fb-00a0c91eede9継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ログレコードを表示可能な形式に変換し、汎用の監視ツールを使用して表示できるようにします。

メソッド 4

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

vtbl 3 HRESULT GetColumnCount(INT* plColumnCount)

この CRM コンペンセーターが使用する種類のログレコード内のフィールド(列)数を取得します。

plColumnCount

INT*

out

ログレコード内のフィールド(列)数。

戻り値

このメソッドは次の値を返すことがあります。

戻り値	説明
S_OK	メソッドが正常に完了しました。
E_POINTER	引数として NULL ポインターが指定されました。

vtbl 4 HRESULT GetColumnHeaders(VARIANT* pHeaders)

情報を表示する際に列見出しとして使用できるように、フィールド(列)の名前を取得します。

pHeaders

VARIANT*

out

フィールド名を Variant 文字列として格納した Variant 配列。

戻り値

このメソッドは次の値を返すことがあります。

戻り値	説明
S_OK	メソッドが正常に完了しました。
E_POINTER	引数として NULL ポインターが指定されました。

vtbl 5 HRESULT GetColumn(CrmLogRecordRead CrmLogRec, VARIANT* pFormattedLogRecord)

1 つの非構造化ログレコードを、表示可能なフィールドの配列に整形します。

CrmLogRec	CrmLogRecordRead	in	整形する非構造化ログレコード。CrmLogRecordRead 構造体として指定します。
pFormattedLogRecord	VARIANT*	out	整形されたログレコード。このログレコード内のフィールドを Variant 文字列とした Variant 配列として返されます。

戻り値

このメソッドは次の値を返すことがあります。

戻り値	説明
S_OK	メソッドが正常に完了しました。
E_POINTER	引数として NULL ポインターが指定されました。
E_FAIL	ログレコードを整形できませんでした。

vtbl 6 HRESULT GetColumnVariants(VARIANT LogRecord, VARIANT* pFormattedLogRecord)

1 つの構造化ログレコードを、表示可能なフィールドの配列に整形します。

LogRecord	VARIANT	in	整形する構造化ログレコード。
pFormattedLogRecord	VARIANT*	out	このログレコード内のフィールドを Variant 文字列とした Variant 配列。

戻り値

このメソッドは次の値を返すことがあります。

戻り値	説明
S_OK	メソッドが正常に完了しました。
E_POINTER	引数として NULL ポインターが指定されました。
E_FAIL	ログレコードを整形できませんでした。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ICrmFormatLogRecords "{9C51D821-C98B-11D1-82FB-00A0C91EEDE9}"
#usecom global ICrmFormatLogRecords IID_ICrmFormatLogRecords "{}"
#comfunc global ICrmFormatLogRecords_GetColumnCount     3 var
#comfunc global ICrmFormatLogRecords_GetColumnHeaders   4 var
#comfunc global ICrmFormatLogRecords_GetColumn          5 int,var
#comfunc global ICrmFormatLogRecords_GetColumnVariants  6 int,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_ICrmFormatLogRecords "{9C51D821-C98B-11D1-82FB-00A0C91EEDE9}"
#usecom global ICrmFormatLogRecords IID_ICrmFormatLogRecords "{}"
#comfunc global ICrmFormatLogRecords_GetColumnCount     3 sptr
#comfunc global ICrmFormatLogRecords_GetColumnHeaders   4 sptr
#comfunc global ICrmFormatLogRecords_GetColumn          5 int,sptr
#comfunc global ICrmFormatLogRecords_GetColumnVariants  6 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。