PdhVbOpenLog 関数
PdhVbOpenLog 関数は、指定されたログ ファイルを読み取りおよび書き込み用に開きます。 この関数は PdhOpenLog を呼び出します。
重要
このトピックで説明する関数は、今後変更または使用できない可能性があります。 代わりに、「 パフォーマンス カウンター関数」で説明されている関数を使用することをお勧めします。
Function PdhVbOpenLog( _ ByVal szLogFileName As LPCTSTR, _ ByVal dwAccessFlags As DWORD, _ ByVal lpdwLogType As LPDWORD, _ ByVal hQuery As PDH_HQUERY, _ ByVal dwMaxSize As DWORD, _ ByVal szUserCaption As LPCSTR, _ ByRef phLog As PDH_HLOG _ ) As DWORD
パラメーター
-
szLogFileName [in]
-
開くログ ファイルの名前を指定する文字列へのポインター。
ログ ファイルに SQL データが含まれている場合、ログ ファイルの名前の形式は **SQL:DataSourceName!**LogFileName です。 この場合、 lpdwLogType パラメーターの値はPDH_LOG_TYPE_SQL。
-
dwAccessFlags [in]
-
ログ ファイルを開くときに指定するアクセスの種類。 このパラメーターには、次の値のいずれかを指定できます。
値 説明 - PDH_LOG_READ_ACCESS
読み取り操作用にログ ファイルが開かれます。 - PDH_LOG_WRITE_ACCESS
書き込み操作用に新しいログ ファイルが開かれます。 - PDH_LOG_UPDATE_ACCESS
書き込み操作用に既存のログ ファイルが開かれます。 前の表から選択した値は、OR 演算子と次のいずれかの作成アクセス フラグを使用して組み合わせることができます。
値 説明 - PDH_LOG_CREATE_NEW
指定した名前の新しいログ ファイルが作成されます。 - PDH_LOG_CREATE_ALWAYS
指定した名前の新しいログ ファイルが作成され、同じ名前の既存のログ ファイルが消去されます。 - PDH_LOG_OPEN_EXISTING
指定した名前の既存のログ ファイルが開かれます。 指定した名前のログ ファイルが存在しない場合、これはPDH_LOG_CREATE_NEWと等しくなります。 - PDH_LOG_OPEN_ALWAYS
指定した名前の既存のログ ファイルが開かれるか、指定した名前の新しいログ ファイルが作成されます。 -
lpdwLogType [in]
-
開くログ ファイルの種類を示す変数へのポインター。 このパラメーターには、次の値のいずれかを指定できます。
値 説明 - PDH_LOG_TYPE_UNDEFINED
未定義のログ ファイル形式。 - PDH_LOG_TYPE_CSV
最初の行に列ヘッダーを含むテキスト ファイルと、後続の各行の個々のデータ サンプル。 - PDH_LOG_TYPE_SQL
ログ ファイル内のデータは SQL にあります。 - PDH_LOG_TYPE_TSV
PDH_LOG_TYPE_CSVと同じです。 - PDH_LOG_TYPE_BINARY
バイナリ ログ ファイル形式。 循環ログ ファイルが含まれます。 - PDH_LOG_TYPE_PERFMON
Perfmon ログ ファイル形式。 -
hQuery [in]
-
クエリ ハンドル。 このハンドルは 、PdhVbOpenQuery 関数によって返されます。
ログ ファイルを読み取り用に開く場合、このパラメーターは NULL にすることができます。
-
dwMaxSize [in]
-
ログ ファイルの最大サイズ (バイト単位)。 この値は、ログ ファイルが制限付きサイズまたは循環ログ ファイルである場合にのみ使用されます。
-
szUserCaption [in]
-
ログ ファイルのユーザー定義のキャプションを指定する文字列へのポインター。 ログ ファイル キャプションは、通常、ログ ファイルの内容を記述します。 既存のログ ファイルを開くと、このパラメーターの値は無視されます。
-
phLog [in, ref]
-
開かれたログ ファイルへのハンドルを受け取るバッファーへのポインター。
戻り値
関数が成功すると、0 が返されます。
関数が失敗した場合、戻り値は システム エラー コード または PDH エラー コードです。 使用できる値を次に示します。
| リターン コード | 説明 |
|---|---|
|
要求されたデータが、指定されたバッファーよりも大きい。 要求されたデータを返すことができません。 |
|
1 つ以上の文字列バッファーが正しいサイズではありません。 |
|
このハンドルは有効な PDH オブジェクトではありません。 |
|
指定したログ ファイルを開くことができません。 |
|
指定したファイルが見つかりません。 |
注釈
この関数を使用してパフォーマンス データをログ ファイルに書き込む場合は、まず PdhVbOpenQuery を使用してクエリを開く必要があります。
この関数を呼び出す前に、現在開いているクエリがあり、必要なカウンターを追加する必要があります。
Perfmon 形式のログ ファイルは読み取り専用に開くことができます。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント |
Windows XP [デスクトップ アプリのみ] |
| サポートされている最小のサーバー |
Windows Server 2003 [デスクトップ アプリのみ] |
| ライブラリ |
|
| [DLL] |
|