UrlApplySchemeA-Funktion (shlwapi.h)

  • Artikel

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

[out] pszOut

Typ: PTSTR

Ein Zeiger auf einen Puffer, der bei erfolgreicher Rückgabe dieser Funktion eine null-endende Zeichenfolge empfängt, die auf die von pszIn angegebene URL festgelegt und in das Standardformat schema://URL_string 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ückgibt, 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.

dwFlags

Art: 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 keins bestimmen kann. Das Standardpräfix wird in der Registrierung gespeichert, ist aber in der Regel "http".

URL_APPLY_GUESSSCHEME

Versuchen Sie, das Schema zu ermitteln, indem Sie pszIn untersuchen.

URL_APPLY_GUESSFILE

Versuchen Sie, eine Datei-URL aus pszIn zu ermitteln.

URL_APPLY_FORCEAPPLY

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

Rückgabewert

Typ: HRESULT

Gibt einen COM-Standardrückgabewert zurück, einschließlich der folgenden.

Rückgabecode BESCHREIBUNG
S_OK
 Es wurde ein Schema festgelegt. pszOut verweist auf eine Zeichenfolge, die die URL mit dem Präfix des Schemas enthält. Der Wert von pcchOut wird auf die Anzahl der Zeichen in der Zeichenfolge festgelegt, ohne das abschließende NULL-Zeichen zu zählen.
S_FALSE
 Es sind keine Fehler aufgetreten, aber es wurde kein Präfix vorangestellt.
E_POINTER
 Der Puffer war zu klein. Der Wert von pcchOut wird auf die Mindestanzahl von Zeichen festgelegt, die der Puffer enthalten können muss, einschließlich des abschließenden NULL-Zeichens .

Hinweise

Wenn die URL über ein gültiges Schema verfügt, wird die Zeichenfolge nicht geändert. Fast jede Kombination von zwei oder mehr Zeichen, gefolgt von einem Doppelpunkt, wird jedoch als Schema analysiert. Gültige Zeichen sind einige gängige Satzzeichen, z. B. ".". Wenn Ihre Eingabezeichenfolge zu dieser Beschreibung passt, kann UrlApplyScheme sie als gültig behandeln und kein Schema anwenden. Um zu erzwingen, dass die Funktion ein Schema auf eine URL anwendet, legen Sie die flags 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 ist die Funktion nicht in der Lage, ein gültiges Schema zu bestimmen. Das zweite Flag garantiert, dass die Funktion das Standardschema auf die URL anwendet, wenn kein gültiges Schema bestimmt werden kann.

Hinweis

Der shlwapi.h-Header definiert UrlApplyScheme 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 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
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)