UrlEscapeW.3w

Langue: en

Version: Jun 2009 (debian - 07/07/09)

Section: 3 (Bibliothèques de fonctions)

NAME

UrlEscapeW (SHLWAPI.@)

SYNOPSIS

HRESULT UrlEscapeW
 (
  LPCWSTR pszUrl,
  LPWSTR  pszEscaped,
  LPDWORD pcchEscaped,
  DWORD   dwFlags
 )

DESCRIPTION

Converts unsafe characters in a Url into escape sequences.

PARAMS

pszUrl [In] Url to modify.

pszEscaped [Out] Destination for modified Url.

pcchEscaped [In/Out] Length of pszUrl, destination for length of pszEscaped.

dwFlags [In] URL_ flags from "shlwapi.h".

RETURNS

Success: S_OK. pszEscaped contains the escaped Url, pcchEscaped contains its length.

Failure: E_POINTER, if pszEscaped is not large enough. In this case pcchEscaped is set to the required length.

Converts unsafe characters into their escape sequences.

NOTES

- By default this function stops converting at the first '?' or '#' character.

- If dwFlags contains URL_ESCAPE_SPACES_ONLY then only spaces are converted, but the conversion continues past a '?' or '#'.

- Note that this function did not work well (or at all) in shlwapi version 4.

BUGS

Only the following flags are implemented:

     URL_ESCAPE_SPACES_ONLY

     URL_DONT_ESCAPE_EXTRA_INFO

     URL_ESCAPE_SEGMENT_ONLY

     URL_ESCAPE_PERCENT

IMPLEMENTATION

Defined in "shlwapi.h".

Implemented in "dlls/shlwapi/url.c".

Debug channel "shell".