WsEncodeUrl function (webservices.h)

Article
02/22/2024

Encodes the specified WS_URL into a URL string given its component parts. Values are escaped as necessary, combined, and stored in the specified WS_HEAP, and the result is returned as a WS_STRING.

Syntax

HRESULT WsEncodeUrl(
  [in]           const WS_URL *url,
  [in]           ULONG        flags,
  [in]           WS_HEAP      *heap,
  [out]          WS_STRING    *outUrl,
  [in, optional] WS_ERROR     *error
);

Parameters

[in] url

A reference to the WS_URL to encode.

[in] flags

The value of this parameter determines the URL scheme evaluation method. See WS_URL_FLAGS.

[in] heap

A pointer to a WS_HEAP in which to allocate URL.

[out] outUrl

A pointer to the resulting URL string.

[in, optional] error

A pointer to a WS_ERROR object where additional information about the error should be stored if the function fails.

Return value

This function can return one of these values.

Return code	Description
E_INVALIDARG	One or more arguments are invalid.
E_OUTOFMEMORY	Ran out of memory.
WS_E_INVALID_FORMAT	The URL data being encoded was not valid according to the URL syntax.
Other Errors	This function may return other errors not listed above.

Remarks

If a scheme is not recognized in the url parameter the function returns WS_E_INVALID_FORMAT.
Only scheme types identified in WS_URL_SCHEME_TYPE are supported.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 R2 [desktop apps \| UWP apps]
Target Platform	Windows
Header	webservices.h
Library	WebServices.lib
DLL	WebServices.dll

Share via