GetLogContainerName 関数 (clfsw32.h)
指定したコンテナーの完全なパス名を取得します。 この関数は主に、ScanLogContainers の呼び出しで返されるCLFS_CONTAINER_INFORMATION構造体で参照されるコンテナーの完全なパス名を取得するために使用されます。
構文
CLFSUSER_API BOOL GetLogContainerName(
[in] HANDLE hLog,
[in] CLFS_CONTAINER_ID cidLogicalContainer,
[in, out] LPCWSTR pwstrContainerName,
[in] ULONG cLenContainerName,
[in, out, optional] PULONG pcActualLenContainerName
);
パラメーター
[in] hLog
CreateLogFile の正常な呼び出しから取得されたログへのハンドル。
ログ ハンドルは、ログ ストリームまたは物理ログを参照できます。
[in] cidLogicalContainer
コンテナーに関連付けられている一意識別子。
[in, out] pwstrContainerName
ログ コンテナーの完全なパスと名前をワイド文字で受け取る、ユーザー割り当てバッファーへのポインター。
[in] cLenContainerName
pwstrContainerName が指すバッファーのサイズ (文字単位)。
[in, out, optional] pcActualLenContainerName
取得される完全なコンテナー パス名の実際の文字数を受け取る変数へのポインター。
関数が成功した場合、このパラメーターの値は cLenContainerName 以下になります。 バッファーがコンテナー パス名全体を格納するのに十分な大きさでない場合、関数は ERROR_MORE_DATA で失敗し、このパラメーターを完全パス名に必要なサイズに設定します。 その他のエラーの場合、値は定義されていません。
戻り値
関数が成功すると、戻り値は 0 以外になります。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。 次の一覧は、考えられるエラー コードを示しています。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows Server 2003 R2 [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | clfsw32.h |
Library | Clfsw32.lib |
[DLL] | Clfsw32.dll |