UrlGetPartA-Funktion (shlwapi.h)

Artikel
08/26/2023

Akzeptiert eine URL-Zeichenfolge und gibt einen angegebenen Teil dieser URL zurück.

Syntax

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

Parameter

[in] pszIn

Typ: PCTSTR

Eine NULL-Zeichenfolge mit maximaler Länge INTERNET_MAX_URL_LENGTH, die die URL enthält.

[out] pszOut

Typ: PTSTR

Ein Zeiger auf einen Puffer, der bei erfolgreicher Rückgabe dieser Funktion eine NULL-beendete Zeichenfolge mit dem angegebenen Teil der URL empfängt.

[in, out] pcchOut

Typ: DWORD*

Ein Zeiger auf einen Wert, der beim Eintrag auf die Anzahl der Zeichen im puffer pszOut festgelegt ist. Wenn diese Funktion erfolgreich zurückgegeben wird, hängt der Wert davon ab, ob die Funktion erfolgreich ist oder E_POINTER zurückgibt. Für andere Rückgabewerte ist der Wert dieses Parameters bedeutungslos.

dwPart

Art: DWORD

Die Flags, die angeben, welcher Teil der URL abgerufen werden soll. Sie kann einen der folgenden Werte aufweisen.

URL_PART_HOSTNAME

Der Hostname.

URL_PART_PASSWORD

Das Kennwort.

URL_PART_PORT

Die Portnummer.

URL_PART_QUERY

Der Abfrageteil der URL.

URL_PART_SCHEME

Das URL-Schema.

URL_PART_USERNAME

Benutzername

dwFlags

Art: DWORD

Ein Flag, das festgelegt werden kann, um das URL-Schema beizubehalten, zusätzlich zu dem Teil, der von dwPart angegeben wird.

URL_PARTFLAG_KEEPSCHEME

Behalten Sie das URL-Schema bei.

Rückgabewert

Typ: HRESULT

Gibt bei erfolgreicher Ausführung S_OK zurück. Der Wert, auf den von "pcchOut" verwiesen wird, wird auf die Anzahl der Zeichen festgelegt, die in den Ausgabepuffer geschrieben werden, mit Ausnahme des beendenden NULL. Wenn der Puffer zu klein war, wird E_POINTER zurückgegeben, und der Wert, auf den von pcchOut verwiesen wird, wird auf die Mindestanzahl von Zeichen festgelegt, die der Puffer enthalten können muss, einschließlich des beendenden NULL-Zeichens . Andernfalls wird ein COM-Fehlerwert zurückgegeben.

Hinweise

Hinweis

Der shlwapi.h-Header definiert UrlGetPart als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit nicht codierungsneutralem Code kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen


Unterstützte Mindestversion (Client)	Windows 2000 Professional, Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	shlwapi.h
Bibliothek	Shlwapi.lib
DLL	Shlwapi.dll (Version 5.0 oder höher)

Share via