Fungsi RtlUnicodeStringInitEx (ntstrsafe.h)

  • Artikel

Fungsi RtlUnicodeStringInitEx menginisialisasi struktur UNICODE_STRING .

Sintaks

NTSTRSAFEDDI RtlUnicodeStringInitEx(
  [out]          PUNICODE_STRING  DestinationString,
  [in, optional] NTSTRSAFE_PCWSTR pszSrc,
  [in]           DWORD            dwFlags
);

Parameter

[out] DestinationString

Pilihan. Penunjuk ke struktur UNICODE_STRING yang akan diinisialisasi. Pointer pszSrc disalin ke dalam struktur UNICODE_STRING parameter DestinationString. Jumlah maksimum karakter dalam string yang ditinjuk pszSrc adalah NTSTRSAFE_UNICODE_STRING_MAX_CCH. DestinationString bisa NULL, tetapi hanya jika STRSAFE_IGNORE_NULLS diatur dalam dwFlags.

[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.

[in] dwFlags

Bendera berikut didefinisikan:

STRSAFE_IGNORE_NULLS

Jika bendera ini diatur, penunjuk sumber bisa null. RtlUnicodeStringInitEx memperlakukan penunjuk buffer sumber NULL seperti string kosong (TEXT("")), yang dapat disalin.

Nilai kembali

RtlUnicodeStringInitEx mengembalikan salah satu nilai NTSTATUS berikut.

Menampilkan kode Deskripsi
STATUS_SUCCESS
 Status keberhasilan ini berarti bahwa data sumber ada, string disalin tanpa pemotokan, 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.
 

RtlUnicodeStringInitEx mengembalikan nilai STATUS_INVALID_PARAMETER ketika salah satu hal berikut ini terjadi:

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

Keterangan

Fungsi RtlUnicodeStringInitEx melakukan hal berikut:

  • Mengatur anggota Panjang struktur UNICODE_STRING ke panjang, dalam byte, dari string yang dirujuk parameter pszSrc .
  • Mengatur anggota MaximumLength dari struktur UNICODE_STRING ke panjang, dalam byte, dari string yang dirujuk parameter pszSrc menjadi plus 2 byte.
  • Mengatur anggota Buffer dari struktur UNICODE_STRING ke alamat yang ditentukan parameter pszSrc .
Penunjuk DestinationString tidak boleh NULL kecuali bendera STRSAFE_IGNORE_NULLS diatur.

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

Persyaratan

Persyaratan Nilai
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 Bagaimanapun, jika string yang dimanipulasi selalu berada dalam memori, jika tidak, PASSIVE_LEVEL

Lihat juga

RtlUnicodeStringInit

UNICODE_STRING