UrlGetPartA-Funktion (shlwapi.h)

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 mit Null beendete Zeichenfolge mit maximaler Länge INTERNET_MAX_URL_LENGTH, die die URL enthält.

[out] pszOut

Typ: PTSTR-

Ein Zeiger auf einen Puffer, der, wenn diese Funktion erfolgreich zurückgegeben wird, 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 pszOut- Puffer 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. Bei anderen Rückgabewerten ist der Wert dieses Parameters bedeutungslos.

dwPart

Typ: DWORD-

Die Flags, die angeben, welcher Teil der URL abgerufen werden soll. Er 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 Abfragebereich der URL.

URL_PART_SCHEME

Das URL-Schema.

URL_PART_USERNAME

Der Benutzername.

dwFlags

Typ: DWORD-

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

URL_PARTFLAG_KEEPSCHEME

Behalten Sie das URL-Schema bei.

Rückgabewert

Typ: HRESULT-

Gibt S_OK zurück, wenn dies erfolgreich ist. Der Wert, auf den pcchOut- verweist, wird auf die Anzahl der Zeichen festgelegt, die in den Ausgabepuffer geschrieben wurden, mit Ausnahme des endenden NULL-. Wenn der Puffer zu klein war, wird E_POINTER zurückgegeben, und der wert, auf den pcchOut- verweist, wird auf die minimale Anzahl von Zeichen festgelegt, die der Puffer enthalten muss, einschließlich des endenden NULL- Zeichens. Andernfalls wird ein COM-Fehlerwert zurückgegeben.

Bemerkungen

Anforderungen