UrlUnescapeW-Funktion (shlwapi.h)

  • Artikel

Konvertiert Escapesequenzen wieder in normale Zeichen.

Syntax

LWSTDAPI UrlUnescapeW(
  [in, out]           PWSTR pszUrl,
  [out, optional]     PWSTR pszUnescaped,
  [in, out, optional] DWORD *pcchUnescaped,
                      DWORD dwFlags
);

Parameter

[in, out] pszUrl

Typ: PTSTR

Ein Zeiger auf eine NULL-Zeichenfolge mit der URL. Wenn dwFlags auf URL_UNESCAPE_INPLACE festgelegt ist, wird die konvertierte Zeichenfolge über diesen Parameter zurückgegeben.

[out, optional] pszUnescaped

Typ: PTSTR

Ein Zeiger auf einen Puffer, der eine NULL-endende Zeichenfolge empfängt, die die version ohne Escapezeichen von pszURL enthält. Wenn URL_UNESCAPE_INPLACE in dwFlags festgelegt ist, wird dieser Parameter ignoriert.

[in, out, optional] pcchUnescaped

Typ: DWORD*

Die Anzahl der Zeichen im Puffer, auf die pszUnescaped verweist. Beim Eintrag wird der Wert pcchUnescaped auf die Größe des Puffers festgelegt. Wenn die Funktion einen Erfolgscode zurückgibt und das URL_UNESCAPE_INPLACE-Flag nicht festgelegt ist, wird der Wert, auf den pcchUnescaped zeigt, auf die Anzahl der Zeichen festgelegt, die in diesen Puffer geschrieben wurden, ohne das abschließende NULL-Zeichen zu zählen. Wenn ein E_POINTER Fehlercode zurückgegeben wird, war der Puffer zu klein, und der Wert, auf den pcchUnescaped zeigt, wird auf die erforderliche Anzahl von Zeichen festgelegt, die der Puffer enthalten können muss. Wenn andere Fehler zurückgegeben werden, ist der Wert, auf den pcchUnescaped verweist, nicht definiert.

dwFlags

Art: DWORD

Flags, die steuern, welche Zeichen keine Kulisse enthalten. Dies kann eine Kombination der folgenden Flags sein.

URL_DONT_UNESCAPE_EXTRA_INFO

Konvertieren Sie nicht # oder ? oder beliebige Zeichen, die in der Zeichenfolge darauf folgen.

URL_UNESCAPE_AS_UTF8

In Windows 8 eingeführt. Decodieren Sie URLs, die mithilfe des flags URL_ESCAPE_AS_UTF8 codiert wurden.

URL_UNESCAPE_INPLACE

Verwenden Sie pszURL , um die konvertierte Zeichenfolge anstelle von pszUnescaped zurückzugeben.

Rückgabewert

Typ: HRESULT

Gibt bei erfolgreicher Ausführung S_OK zurück. Wenn das flag URL_UNESCAPE_INPLACE nicht festgelegt ist, wird der Wert, auf den von pcchUnescaped verwiesen wird, auf die Anzahl der Zeichen im Ausgabepuffer festgelegt, auf die pszUnescaped verweist. Gibt E_POINTER zurück, wenn das URL_UNESCAPE_INPLACE-Flag nicht festgelegt ist und der Ausgabepuffer zu klein ist. Der Parameter pcchUnescaped wird auf die erforderliche Puffergröße festgelegt. Andernfalls wird ein Standardfehlerwert zurückgegeben.

Hinweise

Eine Escapesequenz hat die Form "%xy".

Eingabezeichenfolgen dürfen nicht länger als INTERNET_MAX_URL_LENGTH sein.

Hinweis

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

   
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)