Fungsi WindowsCreateStringReference (winstring.h)

Membuat referensi string baru berdasarkan string yang ditentukan.

Sintaks

HRESULT WindowsCreateStringReference(
  PCWSTR         sourceString,
  UINT32         length,
  HSTRING_HEADER *hstringHeader,
  HSTRING        *string
);

Parameter

sourceString

Jenis: [in] PCWSTR

String yang dihentikan null untuk digunakan sebagai sumber untuk HSTRING baru.

Nilai NULL mewakili string kosong, jika nilai panjangnya adalah 0. Harus dialokasikan pada bingkai tumpukan.

length

Jenis: [in] UINT32

Panjang sourceString, dalam karakter Unicode. Harus 0 jika sourceStringNULL. Jika lebih besar dari 0, sourceString harus memiliki karakter null yang mengakhiri.

hstringHeader

Jenis: [out] HSTRING_HEADER*

Penunjuk ke struktur yang digunakan Windows Runtime untuk mengidentifikasi string sebagai referensi string, atau string cepat.

string

Jenis: [out] HSTRING*

Penunjuk ke string yang baru dibuat, atau NULL jika terjadi kesalahan. Konten apa pun yang ada dalam string ditimpa. HSTRING adalah jenis handel standar.

Nilai kembali

Jenis: HRESULT

Fungsi ini dapat mengembalikan salah satu nilai ini.

Menampilkan kode	Deskripsi
S_OK	HSTRING berhasil dibuat.
E_INVALIDARG	Baik string atau hstringHeaderNULL, atau string tidak dihentikan null.
E_OUTOFMEMORY	Gagal mengalokasikan HSTRING baru.
E_POINTER	sourceStringNULL dan panjangnya bukan nol.

Keterangan

Gunakan fungsi WindowsCreateStringReference untuk membuat HSTRING dari string yang ada. HSTRING semacam ini dinamai string fast-pass. Tidak seperti HSTRING yang dibuat oleh fungsi WindowsCreateString , masa pakai buffer cadangan di HSTRING baru tidak dikelola oleh Windows Runtime. Penelepon mengalokasikan sourceString pada bingkai tumpukan, bersama dengan HSTRING_HEADER yang tidak diinisialisasi, untuk menghindari alokasi tumpukan dan menghilangkan risiko kebocoran memori. Pemanggil harus memastikan bahwa sourceString dan konten hstringHeader tetap tidak berubah selama masa pakai HSTRING yang terpasang.

Anda tidak perlu memanggil fungsi WindowsDeleteString untuk membatalkan alokasi HSTRING fast-pass yang dibuat oleh fungsi WindowsCreateStringReference .

Untuk membuat HSTRING kosong, berikan NULL untuk sourceString dan 0 untuk panjangnya.

Windows Runtime melacak string cepat dengan menggunakan struktur HSTRING_HEADER , yang dikembalikan dalam parameter keluar hstringHeader . Jangan ubah isi HSTRING_HEADER.

Persyaratan

Klien minimum yang didukung	Windows 8 [aplikasi desktop | Aplikasi UWP]
Server minimum yang didukung	Windows Server 2012 [aplikasi desktop | Aplikasi UWP]
Target Platform	Windows
Header	winstring.h

Lihat juga

WindowsCreateString

WindowsDeleteString