UrlApplySchemeA-Funktion (shlwapi.h)

Artikel
11/20/2024

Bestimmt ein Schema für eine angegebene URL-Zeichenfolge und gibt eine Zeichenfolge mit einem entsprechenden Präfix zurück.

Syntax

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

Parameter

[in] pszIn

Typ: PCTSTR-

Eine mit Null beendete Zeichenfolge mit maximaler Länge INTERNET_MAX_URL_LENGTH, die eine URL enthält.

[out] pszOut

Typ: PTSTR-

Ein Zeiger auf einen Puffer, der, wenn diese Funktion erfolgreich zurückgegeben wird, eine null-beendete Zeichenfolge empfängt, die auf die durch pszIn- angegebene URL festgelegt und in das Standardschema Schema://URL_string Format konvertiert wird.

[in, out] pcchOut

Typ: DWORD*-

Die Adresse eines Werts, der auf die Anzahl der Zeichen im pszOut Puffer festgelegt ist. Wenn die Funktion 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.

dwFlags

Typ: DWORD-

Die Flags, die angeben, wie das Schema bestimmt werden soll. Die folgenden Flags können kombiniert werden.

URL_APPLY_DEFAULT

Wenden Sie das Standardschema an, wenn UrlApplyScheme- eines nicht ermitteln kann. Das Standardpräfix wird in der Registrierung gespeichert, ist jedoch in der Regel "http".

URL_APPLY_GUESSSCHEME

Versuchen Sie, das Schema zu ermitteln, indem Sie pszInuntersuchen.

URL_APPLY_GUESSFILE

Versuchen Sie, eine Datei-URL aus pszInzu ermitteln.

URL_APPLY_FORCEAPPLY

Erzwingen Sie UrlApplyScheme-, ein Schema für pszIn zu bestimmen.

Rückgabewert

Typ: HRESULT-

Gibt einen standardmäßigen COM-Rückgabewert zurück, einschließlich der folgenden.

Rückgabecode	Beschreibung
S_OK	Es wurde ein Schema ermittelt. pszOut verweist auf eine Zeichenfolge, die die URL mit dem Präfix des Schemas enthält. Der Wert pcchOut- wird auf die Anzahl der Zeichen in der Zeichenfolge festgelegt und nicht auf das endende NULL- zeichen gezählt.
S_FALSE	Es gab keine Fehler, aber es wurde kein Präfix vorangestellt.
E_POINTER	Der Puffer war zu klein. Der Wert pcchOut- wird auf die minimale Anzahl von Zeichen festgelegt, die der Puffer enthalten muss, einschließlich des endenden NULL- Zeichens.

Bemerkungen

Wenn die URL über ein gültiges Schema verfügt, wird die Zeichenfolge nicht geändert. Fast jede Kombination aus zwei oder mehr Zeichen gefolgt von einem Doppelpunkt wird jedoch als Schema analysiert. Gültige Zeichen umfassen einige gängige Satzzeichen, z. B. ".". Wenn Ihre Eingabezeichenfolge zu dieser Beschreibung passt, kann UrlApplyScheme- sie als gültig behandeln und kein Schema anwenden. Wenn Sie erzwingen möchten, dass die Funktion ein Schema auf eine URL anwendet, legen Sie die Kennzeichnungen URL_APPLY_FORCEAPPLY und URL_APPLY_DEFAULT in dwFlags-fest. Diese Kombination von Flags erzwingt die Funktion, ein Schema auf die URL anzuwenden. In der Regel kann die Funktion kein gültiges Schema ermitteln. Das zweite Kennzeichen garantiert, dass die Funktion, wenn kein gültiges Schema bestimmt werden kann, das Standardschema auf die URL anwendet.

Anmerkung

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

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Windows 2000 Professional, Windows XP [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Zielplattform-	Fenster
Header-	shlwapi.h
Library	Shlwapi.lib
DLL-	Shlwapi.dll (Version 5.0 oder höher)

Freigeben über