Fungsi GetFileSecurityA (winbase.h)

Artikel
08/27/2023

Fungsi GetFileSecurity memperoleh informasi tertentu tentang keamanan file atau direktori. Informasi yang diperoleh dibatasi oleh hak akses dan hak istimewa penelepon.

Fungsi GetNamedSecurityInfo menyediakan fungsionalitas yang mirip dengan GetFileSecurity untuk file serta jenis objek lainnya.

Sintaks

BOOL GetFileSecurityA(
  [in]            LPCSTR               lpFileName,
  [in]            SECURITY_INFORMATION RequestedInformation,
  [out, optional] PSECURITY_DESCRIPTOR pSecurityDescriptor,
  [in]            DWORD                nLength,
  [out]           LPDWORD              lpnLengthNeeded
);

Parameter

[in] lpFileName

Penunjuk ke string yang dihentikan null yang menentukan file atau direktori tempat informasi keamanan diambil.

[in] RequestedInformation

Nilai SECURITY_INFORMATION yang mengidentifikasi informasi keamanan yang diminta.

[out, optional] pSecurityDescriptor

Penunjuk ke buffer yang menerima salinan deskriptor keamanan objek yang ditentukan oleh parameter lpFileName . Proses panggilan harus memiliki izin untuk melihat aspek yang ditentukan dari status keamanan objek. Struktur SECURITY_DESCRIPTOR dikembalikan dalam format pendeskripsi keamanan relatif mandiri .

[in] nLength

Menentukan ukuran, dalam byte, dari buffer yang diarahkan oleh parameter pSecurityDescriptor .

[out] lpnLengthNeeded

Penunjuk ke variabel yang menerima jumlah byte yang diperlukan untuk menyimpan deskriptor keamanan lengkap. Jika jumlah byte yang dikembalikan kurang dari atau sama dengan nLength, seluruh deskriptor keamanan dikembalikan dalam buffer output; jika tidak, tidak ada deskriptor yang dikembalikan.

Mengembalikan nilai

Jika fungsi berhasil, nilai yang dikembalikan bukan nol.

Jika fungsi gagal, nilai yang dikembalikan adalah nol. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.

Keterangan

Untuk membaca pemilik, grup, atau DACL dari pendeskripsi keamanan untuk file atau direktori yang ditentukan, DACL untuk file atau direktori harus memberikan akses READ_CONTROL ke pemanggil, atau pemanggil harus menjadi pemilik file atau direktori.

Untuk membaca SACL file atau direktori, hak istimewa SE_SECURITY_NAME harus diaktifkan untuk proses panggilan.

Persyaratan


Klien minimum yang didukung	Windows XP [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Target Platform	Windows
Header	winbase.h (termasuk Windows.h)
Pustaka	Advapi32.lib
DLL	Advapi32.dll