ClfsGetContainerName 関数 (wdm.h)

  • [アーティクル]

ClfsGetContainerName ルーチンは、指定されたコンテナーのパス名を返します。

構文

CLFSUSER_API NTSTATUS ClfsGetContainerName(
  [in]            PLOG_FILE_OBJECT  plfoLog,
  [in]            CLFS_CONTAINER_ID cidLogicalContainer,
  [out]           PUNICODE_STRING   puszContainerName,
  [out, optional] PULONG            pcActualLenContainerName
);

パラメーター

[in] plfoLog

CLFS ログを表す LOG_FILE_OBJECT 構造体へのポインター。 呼び出し元は、 以前に ClfsCreateLogFile を呼び出してこのポインターを取得しました。

[in] cidLogicalContainer

CLFS ログ内のコンテナーの論理識別子。

[out] puszContainerName

UNICODE_STRING構造体へのポインター。 puszContainerName の Buffer メンバーは、コンテナーのパス名を受け取る呼び出し元によって割り当てられたバッファーを指す必要があります。 MaximumLength メンバーは、バッファーのサイズを指定する必要があります。

[out, optional] pcActualLenContainerName

コンテナーのパス名の実際の長さを Unicode 文字で受け取る ULONG 型の変数へのポインター。 このパラメーターは、NULL でもかまいません。

戻り値

ClfsGetContainerName は、Ntstatus.h で定義されている状態コードのいずれかを返します。 次の表は、さまざまな戻り値の意味を示しています。

リターン コード 説明
STATUS_SUCCESS
 puszContainerName の Buffer メンバーは、コンテナーの完全なパス名を受け取ります。 pcActualLenContainerName が NULL でない場合は、完全なパス名の実際の長さを Unicode 文字で受け取ります。
STATUS_BUFFER_OVERFLOW
 完全なパス名の実際の長さ (Unicode 文字) は 、puszContainerName->MaximumLength より大きくなります。 puszContainerName の Buffer メンバーは、puszContainerNameMaximumLength で指定された文字数に切り捨てられたコンテナーの完全なパス名->を受け取ります。 pcActualLenContainerName が NULL でない場合は、完全なパス名の実際の長さを Unicode 文字で受け取ります。
その他
 返されると、 puszContainerName->Buffer と pcActualLenContainerName の 内容は未定義です。

注釈

CLFS の概念と用語の詳細については、「 共通ログ ファイル システム」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows Server 2003 R2、Windows Vista、およびそれ以降のバージョンの Windows で使用できます。
対象プラットフォーム デスクトップ
Header wdm.h (Wdm.h を含む)
Library Clfs.lib
[DLL] Clfs.sys
IRQL <= APC_LEVEL

こちらもご覧ください

ClfsAddLogContainer

ClfsRemoveLogContainer