.\" -*- nroff -*-
.\" Generated file - DO NOT EDIT!
.TH UrlEscapeW 3w "Oct 2012" "Wine API" "Wine API"

.SH NAME
\fBUrlEscapeW\fR (SHLWAPI.@)
.SH SYNOPSIS
HRESULT UrlEscapeW
 (
  LPCWSTR \fIpszUrl\fR,
  LPWSTR  \fIpszEscaped\fR,
  LPDWORD \fIpcchEscaped\fR,
  DWORD   \fIdwFlags\fR
 )

.SH DESCRIPTION
.PP
Converts unsafe characters in a Url into escape sequences. 

.SH PARAMS
\fIpszUrl\fR \fB[In]\fR  Url to modify.
.PP
\fIpszEscaped\fR \fB[Out]\fR  Destination for modified Url.
.PP
\fIpcchEscaped\fR \fB[In/Out]\fR  Length of \fIpszUrl\fR, destination for length of \fIpszEscaped\fR.
.PP
\fIdwFlags\fR \fB[In]\fR  \fBURL_\fR flags from \fB"shlwapi.h"\fR.
.PP

.SH RETURNS
.PP
\fBSuccess:\fR \fBS_OK\fR. \fIpszEscaped\fR contains the escaped Url, \fIpcchEscaped\fR contains its length. 
.PP
\fBFailure:\fR \fBE_POINTER\fR, if \fIpszEscaped\fR is not large enough. In this case \fIpcchEscaped\fR is set to the required length. 
.PP
Converts unsafe characters into their escape sequences. 

.SH NOTES
.PP
\fB-\fR By default this function stops converting at the first \fB'?'\fR or \fB'#'\fR character. 
.PP
\fB-\fR If \fIdwFlags\fR contains \fBURL_ESCAPE_SPACES_ONLY\fR then only spaces are converted, but the conversion continues past a \fB'?'\fR or \fB'#'\fR. 
.PP
\fB-\fR Note that this function did not work well (or at all) in shlwapi version \fB4.\fR 

.SH BUGS
.PP
Only the following flags are implemented: 
.br
     URL_ESCAPE_SPACES_ONLY
.br
     URL_DONT_ESCAPE_EXTRA_INFO
.br
     URL_ESCAPE_SEGMENT_ONLY
.br
     URL_ESCAPE_PERCENT

.SH IMPLEMENTATION
.PP
Declared in \fB"shlwapi.h"\fR. 
.PP
Implemented in \fB"dlls/shlwapi/url.c"\fR. 
.PP
Debug channel \fB"shell"\fR.