ClfsCreateLogFile 関数 (wdm.h)

ClfsCreateLogFile ルーチンは、CLFS ストリームを作成または開きます。 必要に応じて、 ClfsCreateLogFile は、ストリームのレコードを保持する基になる物理ログも作成します。

構文

CLFSUSER_API NTSTATUS ClfsCreateLogFile(
  [out]          PPLOG_FILE_OBJECT    pplfoLog,
  [in]           PUNICODE_STRING      puszLogFileName,
  [in]           ACCESS_MASK          fDesiredAccess,
  [in]           ULONG                dwShareMode,
  [in, optional] PSECURITY_DESCRIPTOR psdLogFile,
  [in]           ULONG                fCreateDisposition,
  [in]           ULONG                fCreateOptions,
  [in]           ULONG                fFlagsAndAttributes,
  [in]           ULONG                fLogOptionFlag,
  [in, optional] PVOID                pvContext,
  [in]           ULONG                cbContext
);

パラメーター

[out] pplfoLog

ストリームの開いているインスタンスを表す LOG_FILE_OBJECT 構造体へのポインターを受け取る変数へのポインター。

[in] puszLogFileName

ストリームまたは基になる物理ログの名前を提供する UNICODE_STRING 構造体へのポインター。

ストリームが既に存在し、専用ログの唯一のストリームである場合、名前の形式は log:physical log name です。 ここで、物理ログ名 は、ストリームのレコードを含む既存の物理ログのパス名 (基になるファイル システム上) です。

ストリームがまだ存在せず、(まだ存在しない) 専用ログの唯一のストリームになる場合、名前には log:physical log name という形式があります。 ここで、物理ログ名 は、ストリームのレコードを保持するために作成される物理ログの、基になるファイル システム上のパス名です。

ストリームが多重化されたログのストリームの 1 つである (またはになる) 場合、名前の形式は log:physical log name::stream name です。 ここで、物理ログ名 は、基になるファイル システム上の、ストリームのレコードを保持する物理ログのパス名であり、 ストリーム名 はその物理ログを共有する (または共有する) ストリームの名前です。

ストリームがない多重化ログを作成する場合は、log:physical log name::という形式の名前を使用します。 ここで、物理ログ名 は、作成する物理ログの、基になるファイル システム上のパス名です。

次の一覧では、有効な名前の例をいくつか示します。

• "Log:c:\myLog" は、専用ログとその 1 つのストリームを作成または開きます。
• "Log:c:\myCommonLog::" は、ストリームがまだない多重化されたログを作成します。
• "Log:c:\myCommonLog::Stream1" は、多重化されたログのストリーム (Stream1) の 1 つを作成または開きます。

[in] fDesiredAccess

(pplfoLog で返されるポインターを使用して) クライアントがストリームに持つアクセスの種類を提供するACCESS_MASK。 このパラメーターが 0 の場合、クライアントはストリームに対して属性のクエリを実行できますが、ストリームから読み取ったり、ストリームに書き込んだりすることはできません。 このパラメーターには、0 または次のフラグの任意の組み合わせを指定できます。

[in] dwShareMode

ストリームの共有モード。0 (共有されていない) または次のフラグの任意の組み合わせにすることができます。

[in, optional] psdLogFile

ストリームのセキュリティ属性を提供する SECURITY_DESCRIPTOR 構造体へのポインター。 このパラメーターは、NULL でもかまいません。

[in] fCreateDisposition

ストリームが既に存在するかどうかによって異なる、実行するアクション。 このパラメーターは、次のいずれかの値に設定する必要があります。

[in] fCreateOptions

ストリームを作成または開くときに適用するオプションを指定するフラグのセット。 このパラメーターには、0 または次のフラグの互換性のある組み合わせを指定できます。

[in] fFlagsAndAttributes

ストリームを通常のアクセス用または読み取り専用アクセス用に開くかどうかを示す 値です。 このパラメーターは、次のいずれかに設定する必要があります。

FILE_ATTRIBUTE_NORMALまたはFILE_ATTRIBUTE_READONLY。

[in] fLogOptionFlag

CLFS と、ストリームを作成または開くコンポーネントとの関係に関するヒント。 このパラメーターは、次のいずれかの値に設定する必要があります。

[in, optional] pvContext

コンテキストへのポインター。 コンテキストの解釈方法は、 fLogOptionsFlag に渡される値によって異なります。

[in] cbContext

pvContext が指すコンテキストのサイズ (バイト単位)。 pvContext が NULL でない場合、このパラメーターは 0 より大きくする必要があります。

戻り値

ClfsCreateLogFile は 、成功した場合STATUS_SUCCESSを返します。それ以外の場合は、Ntstatus.h で定義されているエラー コードのいずれかを返します。

注釈

CLFS ストリームを作成すると、基になる物理 CLFS ログによってサポートされます。 基になるログは、専用 (1 つのストリームのみをバック) または多重化 (複数のストリームをバック) にすることができます。 専用ログは多重化ログに変換できず、多重化ログは専用ログに変換できません。

物理 CLFS ログ名には、.blf 拡張子は含まれません。

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

要件

こちらもご覧ください

ClfsCloseAndResetLogFile

ClfsCloseLogFileObject

ClfsDeleteLogByPointer

ClfsDeleteLogFile