Fungsi RtlUnicodeStringInit (ntstrsafe.h)

Fungsi RtlUnicodeStringInit menginisialisasi struktur UNICODE_STRING .

Sintaks

NTSTRSAFEDDI RtlUnicodeStringInit(
  [out]          PUNICODE_STRING  DestinationString,
  [in, optional] NTSTRSAFE_PCWSTR pszSrc
);

Parameter

[out] DestinationString

Penunjuk ke struktur UNICODE_STRING yang akan diinisialisasi. Penunjuk pszSrc disalin ke dalam struktur UNICODE_STRING parameter DestinationString. Jumlah maksimum karakter dalam string yang ditolak pszSrc adalah NTSTRSAFE_UNICODE_STRING_MAX_CCH.

[in, optional] pszSrc

Pilihan. Penunjuk ke konstanta string yang dihentikan null. Penunjuk string ini akan disalin ke anggota Buffer dari struktur UNICODE_STRING yang diacu oleh parameter DestinationString . Penunjuk string ini bisa NULL.

Mengembalikan nilai

RtlUnicodeStringInit mengembalikan salah satu nilai NTSTATUS berikut.

Menampilkan kode Deskripsi
STATUS_SUCCESS
Status keberhasilan ini berarti bahwa data sumber ada, string disalin tanpa pemotongan, dan buffer tujuan yang dihasilkan dihentikan null.
STATUS_INVALID_PARAMETER
Status kesalahan ini berarti bahwa fungsi menerima parameter input yang tidak valid. Untuk informasi selengkapnya, lihat daftar berikut ini.
 

RtlUnicodeStringInit mengembalikan nilai STATUS_INVALID_PARAMETER saat salah satu hal berikut ini terjadi:

  • Panjang string yang dirujuk parameter pszSrc lebih besar dari NTSTRSAFE_UNICODE_STRING_MAX_CCH karakter.
  • Penunjuk DestinationStringADALAH NULL, tetapi penunjuk pszSrc bukan NULL.
Untuk informasi tentang cara menguji nilai NTSTATUS, lihat Menggunakan Nilai NTSTATUS.

Keterangan

Fungsi RtlUnicodeStringInit melakukan hal berikut:

  • Mengatur anggota Panjang struktur UNICODE_STRING yang ditunjukkan oleh parameter pszSrc ke panjang, dalam byte, dari string yang ditunjukkan parameter pszSrc .
  • Mengatur anggota MaximumLength dari struktur UNICODE_STRING ke panjang, dalam byte, dari string yang dirujuk parameter pszSrc menjadi ditambah 2 byte.
  • Mengatur anggota Buffer dari struktur UNICODE_STRING ke alamat yang ditentukan parameter pszSrc .
Penunjuk DestinationString tidak boleh NULL. Jika Anda perlu menentukan nilai pointer DestinationStringNULL, gunakan fungsi RtlUnicodeStringInitEx.

Untuk informasi selengkapnya tentang fungsi string aman, lihat Menggunakan Fungsi String Aman.

Persyaratan

   
Klien minimum yang didukung Tersedia dimulai dengan Windows XP dengan Paket Layanan 1 (SP1).
Target Platform Desktop
Header ntstrsafe.h (termasuk Ntstrsafe.h)
Pustaka Ntstrsafe.lib
IRQL PASSIVE_LEVEL

Lihat juga

RtlUnicodeStringInitEx

UNICODE_STRING