Fungsi UrlApplySchemeA (shlwapi.h)

Artikel
03/04/2024

Menentukan skema untuk string URL tertentu, dan mengembalikan string dengan awalan yang sesuai.

Sintaks

LWSTDAPI UrlApplySchemeA(
  [in]      PCSTR pszIn,
  [out]     PSTR  pszOut,
  [in, out] DWORD *pcchOut,
            DWORD dwFlags
);

Parameter

[in] pszIn

Jenis: PCTSTR

String yang dihentikan null dengan panjang maksimum INTERNET_MAX_URL_LENGTH yang berisi URL.

[out] pszOut

Jenis: PTSTR

Penunjuk ke buffer yang, ketika fungsi ini berhasil dikembalikan, menerima string yang dihentikan null yang diatur ke URL yang ditentukan oleh pszIn dan dikonversi ke format skema standar://URL_string .

[in, out] pcchOut

Jenis: DWORD*

Alamat nilai yang diatur ke jumlah karakter dalam buffer pszOut . Ketika fungsi kembali, nilai tergantung pada apakah fungsi berhasil atau mengembalikan E_POINTER. Untuk nilai pengembalian lainnya, nilai parameter ini tidak ada artinya.

dwFlags

Jenis: DWORD

Bendera yang menentukan cara menentukan skema. Bendera berikut dapat digabungkan.

URL_APPLY_DEFAULT

Terapkan skema default jika UrlApplyScheme tidak dapat menentukannya. Awalan default disimpan di registri tetapi biasanya "http".

URL_APPLY_GUESSSCHEME

Coba tentukan skema dengan memeriksa pszIn.

URL_APPLY_GUESSFILE

Coba tentukan URL file dari pszIn.

URL_APPLY_FORCEAPPLY

Paksa UrlApplyScheme untuk menentukan skema untuk pszIn.

Nilai kembali

Jenis: HRESULT

Mengembalikan nilai pengembalian COM standar, termasuk yang berikut ini.

Menampilkan kode	Deskripsi
S_OK	Skema ditentukan. pszOut menunjuk ke string yang berisi URL dengan awalan skema. Nilai pcchOut diatur ke jumlah karakter dalam string, tidak menghitung karakter NULL yang mengakhiri.
S_FALSE	Tidak ada kesalahan, tetapi tidak ada awalan yang diawali.
E_POINTER	Buffer terlalu kecil. Nilai pcchOut diatur ke jumlah minimum karakter yang harus dapat dimuat buffer, termasuk karakter NULL yang mengakhiri.

Keterangan

Jika URL memiliki skema yang valid, string tidak akan dimodifikasi. Namun, hampir semua kombinasi dua karakter atau lebih diikuti oleh titik dua akan diurai sebagai skema. Karakter yang valid mencakup beberapa tanda baca umum, seperti ".". Jika string input Anda sesuai dengan deskripsi ini, UrlApplyScheme dapat memperlakukannya sebagai valid dan tidak menerapkan skema. Untuk memaksa fungsi menerapkan skema ke URL, atur bendera URL_APPLY_FORCEAPPLY dan URL_APPLY_DEFAULT di dwFlags. Kombinasi bendera ini memaksa fungsi untuk menerapkan skema ke URL. Biasanya, fungsi tidak akan dapat menentukan skema yang valid. Bendera kedua menjamin bahwa, jika tidak ada skema yang valid yang dapat ditentukan, fungsi akan menerapkan skema default ke URL.

Catatan

Header shlwapi.h mendefinisikan UrlApplyScheme sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta pra-prosesor 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 2000 Professional, Windows XP [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	shlwapi.h
Pustaka	Shlwapi.lib
DLL	Shlwapi.dll (versi 5.0 atau yang lebih baru)

Bagikan melalui