Fungsi ConvertSecurityDescriptorToStringSecurityDescriptorA (sddl.h)

Artikel
08/25/2023

Fungsi ConvertSecurityDescriptorToStringSecurityDescriptor mengonversi deskriptor keamanan menjadi format string. Anda dapat menggunakan format string untuk menyimpan atau mengirimkan deskriptor keamanan.

Untuk mengonversi deskriptor keamanan format string kembali ke deskriptor keamanan fungsional yang valid, panggil fungsi ConvertStringSecurityDescriptorToSecurityDescriptor .

Sintaks

BOOL ConvertSecurityDescriptorToStringSecurityDescriptorA(
  [in]  PSECURITY_DESCRIPTOR SecurityDescriptor,
  [in]  DWORD                RequestedStringSDRevision,
  [in]  SECURITY_INFORMATION SecurityInformation,
  [out] LPSTR                *StringSecurityDescriptor,
  [out] PULONG               StringSecurityDescriptorLen
);

Parameter

[in] SecurityDescriptor

Penunjuk ke deskriptor keamanan untuk dikonversi. Deskriptor keamanan dapat dalam format absolut atau relatif mandiri.

[in] RequestedStringSDRevision

Menentukan tingkat revisi string StringSecurityDescriptor output. Saat ini nilai ini harus SDDL_REVISION_1.

[in] SecurityInformation

Menentukan kombinasi bendera bit SECURITY_INFORMATION untuk menunjukkan komponen pendeskripsi keamanan untuk disertakan dalam string output.

Bendera BACKUP_SECURITY_INFORMATION tidak berlaku untuk fungsi ini. Jika bendera BACKUP_SECURITY_INFORMATION diteruskan, parameter SecurityInformation mengembalikan TRUE dengan output string null .

[out] StringSecurityDescriptor

Penunjuk ke variabel yang menerima penunjuk ke string deskriptor keamanan yang dihentikan null. Untuk deskripsi format string, lihat Format String Deskriptor Keamanan. Untuk membebaskan buffer yang dikembalikan, panggil fungsi LocalFree .

[out] StringSecurityDescriptorLen

Penunjuk ke variabel yang menerima ukuran, dalam TCHAR, dari string deskriptor keamanan yang dikembalikan dalam buffer StringSecurityDescriptor . Parameter ini bisa NULL jika Anda tidak perlu mengambil ukurannya. Ukuran mewakili ukuran buffer dalam WCHAR, bukan jumlah WCHARs dalam string.

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan bukan nol.

Jika fungsi gagal, nilai yang dikembalikan adalah nol. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError. Fungsi GetLastError dapat mengembalikan salah satu kode kesalahan berikut.

Menampilkan kode	Deskripsi
ERROR_INVALID_PARAMETER	Parameter tidak valid.
ERROR_UNKNOWN_REVISION	Tingkat revisi tidak valid.
ERROR_NONE_MAPPED	Pengidentifikasi keamanan (SID) dalam deskriptor keamanan input tidak dapat ditemukan dalam operasi pencarian akun.
ERROR_INVALID_ACL	Daftar kontrol akses (ACL) tidak valid. Kesalahan ini dikembalikan jika bendera SE_DACL_PRESENT diatur dalam deskriptor keamanan input dan DACL adalah NULL.

Keterangan

Jika DACL adalah NULL, dan bit kontrol SE_DACL_PRESENT diatur dalam deskriptor keamanan input, fungsi gagal.

Jika DACL adalah NULL, dan bit kontrol SE_DACL_PRESENT tidak diatur dalam deskriptor keamanan input, string deskriptor keamanan yang dihasilkan tidak memiliki komponen D: . Untuk informasi selengkapnya, lihat Format String Deskriptor Keamanan.

Catatan

Header sddl.h mendefinisikan ConvertSecurityDescriptorToStringSecurityDescriptor sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta praprosesor UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows XP [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows Server 2003 [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	sddl.h
Pustaka	Advapi32.lib
DLL	Advapi32.dll