Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

UrlEscapeSpaces function

A macro that converts space characters into their corresponding escape sequence.

Syntax


HRESULT UrlEscapeSpaces(
  _In_   LPCTSTR pszURL,
  _Out_  LPTSTR pszEscaped,
  _Out_  LPDWORD pcchEscaped
);

Parameters

pszURL [in]

Type: LPCTSTR

A pointer to a URL string. If it does not refer to a file, it must include a valid scheme such as "http://".

pszEscaped [out]

Type: LPTSTR

A pointer to a null-terminated string containing the string pointed to by pszURL, with space characters converted to their escape sequence.

pcchEscaped [out]

Type: LPDWORD

The number of characters in pszEscaped.

Return value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

UrlEscapeSpaces is equivalent to the following:



UrlCanonicalize(pszUrl, 
                pszEscaped, 
                pcchEscaped, 
                URL_ESCAPE_SPACES_ONLY | URL_DONT_ESCAPE_EXTRA_INFO )
				

Requirements

Minimum supported client

Windows 2000 Professional, Windows XP [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Shlwapi.h

Library

Shlwapi.lib

DLL

Shlwapi.dll (version 5.0 or later)

See also

UrlCanonicalize

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.