Fungsi UrlGetPartA (shlwapi.h)

Artikel
20/11/2024

Menerima string URL dan mengembalikan bagian tertentu dari URL tersebut.

Sintaksis

C++

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

Parameter

[in] pszIn

Jenis: PCTSTR

Untai (karakter) dengan panjang maksimum yang dihentikan null INTERNET_MAX_URL_LENGTH yang berisi URL.

[out] pszOut

Jenis: PTSTR

Penunjuk ke buffer yang, ketika fungsi ini berhasil dikembalikan, menerima string null-terminated dengan bagian URL yang ditentukan.

[in, out] pcchOut

Jenis: DWORD*

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

dwPart

Jenis: DWORD

Bendera yang menentukan bagian mana dari URL yang akan diambil. Ini bisa memiliki salah satu nilai berikut.

URL_PART_HOSTNAME

Nama host.

URL_PART_PASSWORD

Kata sandi.

URL_PART_PORT

Nomor port.

URL_PART_QUERY

Bagian kueri URL.

URL_PART_SCHEME

Skema URL.

URL_PART_USERNAME

Nama pengguna.

dwFlags

Jenis: DWORD

Bendera yang dapat diatur untuk menyimpan skema URL, selain bagian yang ditentukan oleh dwPart.

URL_PARTFLAG_KEEPSCHEME

Pertahankan skema URL.

Mengembalikan nilai

Jenis: HRESULT

Mengembalikan S_OK jika berhasil. Nilai yang ditujukkan oleh pcchOut akan diatur ke jumlah karakter yang ditulis ke buffer output, tidak termasuk penghentian NULL. Jika buffer terlalu kecil, E_POINTER dikembalikan, dan nilai yang diacu oleh pcchOut akan diatur ke jumlah minimum karakter yang harus dapat dimuat buffer, termasuk karakter NULL penghentian. Jika tidak, nilai kesalahan COM dikembalikan.

Komentar

Catatan

Header shlwapi.h mendefinisikan UrlGetPart sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta preprosektor 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

Syarat	Nilai
klien minimum yang didukung	Windows 2000 Professional, Windows XP [hanya aplikasi desktop]
server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Platform Target	Windows
Header	shlwapi.h
Pustaka	Shlwapi.lib
DLL	Shlwapi.dll (versi 5.0 atau yang lebih baru)

Bagikan melalui