Fungsi CreateLogFile (clfsw32.h)

Artikel
11/20/2024

Membuat atau membuka log. Log dapat didedikasikan atau dikalikan, dan itu tergantung pada nama log. Gunakan fungsi closeHandle untuk menutup log.

Sintaksis

CLFSUSER_API HANDLE CreateLogFile(
  [in]           LPCWSTR               pszLogFileName,
  [in]           ACCESS_MASK           fDesiredAccess,
  [in]           DWORD                 dwShareMode,
  [in, optional] LPSECURITY_ATTRIBUTES psaLogFile,
  [in]           ULONG                 fCreateDisposition,
  [in]           ULONG                 fFlagsAndAttributes
);

Parameter

[in] pszLogFileName

Nama log.

Nama ini ditentukan saat membuat log dengan menggunakan CreateLogFile. Contoh berikut mengidentifikasi format yang akan digunakan.

log :<LogName>[::<LogStreamName>]

Misalnya: Jalur "LOG:c:\MyDirectory\MyLog" membuat file "c:\MyDirectory\MyLog.blf". Jalur "?? \LOG:\HarddiskVolume1\MyDirectory\MyLog" membuat file "\.\HarddiskVolume1\MyDirectory\MyLog.blf", seperti halnya jalur "\clfs\Device\HarddiskVolume1\MyDirectory\MyLog".

< LogName> sesuai dengan jalur file yang valid dalam sistem file, dan <LogStreamName> adalah nama unik aliran log di log. Untuk informasi selengkapnya, lihatJenis Log .

[in] fDesiredAccess

Jenis akses yang dimiliki handel yang dikembalikan ke objek log.

Nilai	Arti
GENERIC_READ	Menentukan akses baca ke objek.
GENERIC_WRITE	Menentukan akses tulis ke objek.
HAPUS	Tentukan akses penghapusan log

Bitwise ATAU dari dua atau beberapa bendera ini memungkinkan kombinasi akses baca, tulis, dan hapus ke objek.

Catatan Anda harus menentukan akses DELETE agar dapat menghapus log.

Windows Server 2003 R2: Parameter ini harus diatur ke GENERIC_WRITE.

[in] dwShareMode

Mode berbagi file.

Klien tidak dapat meminta mode berbagi yang bertentangan dengan mode apa pun yang ditentukan dalam permintaan terbuka sebelumnya yang memiliki handel terbuka.

Jika parameter ini nol dan fungsi berhasil, objek tidak dapat dibagikan dan tidak dapat dibuka lagi hingga handel ditutup.

Parameter ini bisa berupa satu atau beberapa nilai berikut.

Nilai	Arti
FILE_SHARE_DELETE	Memungkinkan operasi terbuka pada objek untuk meminta akses penghapusan. Tanpa nilai ini, proses lain tidak dapat membuka objek jika akses penghapusan diminta.
FILE_SHARE_READ	Memungkinkan operasi terbuka pada objek untuk meminta akses baca. Tanpa nilai ini, proses lain tidak dapat membuka objek jika akses baca diminta.
FILE_SHARE_WRITE	Memungkinkan operasi terbuka pada objek untuk meminta akses tulis. Tanpa nilai ini, proses lain tidak dapat membuka objek jika akses tulis diminta.

[in, optional] psaLogFile

Penunjuk ke struktur SECURITY_ATTRIBUTES yang menentukan atribut keamanan log.

Ini menentukan apakah handel yang dikembalikan dapat diwariskan oleh proses anak. Jika parameter ini null, handel tidak dapat diwariskan.

lpSecurityDescriptor anggota SECURITY_ATTRIBUTES menentukan pendeskripsi keamanan untuk handel log baru. Jika psaLogFile NULL, objek mendapatkan pendeskripsi keamanan default. Daftar kontrol akses (ACL) di deskriptor keamanan default untuk log berasal dari token utama atau peniruan identitas pembuat.

[in] fCreateDisposition

Tindakan yang harus diambil.

Parameter ini bisa menjadi salah satu nilai berikut.

Nilai	Arti
CREATE_NEW	Membuat file baru dan gagal jika file sudah ada.
OPEN_EXISTING	Membuka file yang ada dan gagal jika file tidak ada.
OPEN_ALWAYS	Membuka file yang ada atau membuat file jika tidak ada.

[in] fFlagsAndAttributes

Atribut file dan bendera untuk file.

Parameter ini dapat mengambil nilai berikut.

Nilai	Arti
FILE_ATTRIBUTE_ARCHIVE	Log non-ephemeral ini harus diarsipkan. Jika bendera ini tidak disediakan, log tidak perlu diarsipkan, dan ekor arsip tidak dipertahankan untuk mendaur ulang kontainer log.
FILE_FLAG_OVERLAPPED	Jika bendera FILE_FLAG_OVERLAPPED diatur, semua nilai bendera lainnya diabaikan. Menentukan FILE_FLAG_OVERLAPPED berarti bahwa file dibuka untuk I/O yang tumpang tindih, yang memungkinkan lebih dari satu operasi I/O dilakukan pada handel log. Jika bendera ini diatur saat membuat log, semua panggilan I/O asinkron ke log tersebut harus menentukan struktur yang tumpang tindih dan disinkronkan dengan penyelesaian panggilan yang ditangguhkan.

Nilai

Arti

FILE_ATTRIBUTE_ARCHIVE

Log non-ephemeral ini harus diarsipkan.

Jika bendera ini tidak disediakan, log tidak perlu diarsipkan, dan ekor arsip tidak dipertahankan untuk mendaur ulang kontainer log.

FILE_FLAG_OVERLAPPED

Jika bendera FILE_FLAG_OVERLAPPED diatur, semua nilai bendera lainnya diabaikan.

Menentukan FILE_FLAG_OVERLAPPED berarti bahwa file dibuka untuk I/O yang tumpang tindih, yang memungkinkan lebih dari satu operasi I/O dilakukan pada handel log. Jika bendera ini diatur saat membuat log, semua panggilan I/O asinkron ke log tersebut harus menentukan struktur yang tumpang tindih dan disinkronkan dengan penyelesaian panggilan yang ditangguhkan.

Mengembalikan nilai

Jika fungsi berhasil, nilai yang dikembalikan adalah handel ke log.

Jika fungsi gagal, nilai yang dikembalikan adalah INVALID_HANDLE_VALUE. Untuk mendapatkan informasi kesalahan yang diperluas, panggil GetLastError.

Daftar berikut mengidentifikasi kemungkinan kode kesalahan:

Persyaratan

Syarat	Nilai
klien minimum yang didukung	Windows Vista [hanya aplikasi desktop]
server minimum yang didukung	Windows Server 2003 R2 [hanya aplikasi desktop]
Platform Target	Windows
Header	clfsw32.h
Pustaka	Clfsw32.lib
DLL	Clfsw32.dll