Toolkit 7.3 APIs Banner [skip navigation]
Office of Information & Technology (OIT) Banner

$$ENCODE^XTHCURL(): Encodes a Query String

Reference Type: Supported, Category: Toolkit—HTTP Client Helper, Integration Agreement: 5554

Description

The $$ENCODE^XTHCURL extrinsic function encodes the query string. The $$MAKEURL^XTHCURL: Creates a URL from Components API uses this extrinsic function.

NOTE: This API was released with Kernel Toolkit patch XT*7.3*123.

NOTE: XTHC* routines are part of the HTTP Client Helper application for developers.

Format

  $$ENCODEURL^XTHCURL(string)

Input Parameters

str:

(required) String of data to be encoded

Output

Returns:

Returns

  • Success:Encoded Query String
  • Fail1^ String not defined(if missing str parameter)

Example:

W $$ENCODE^XTHCURL("1301+clay+st.,Oakland,CA")
1301%2Bclay%2Bst.%2COakland%2CCA

VA (Internet) / VA(Intranet) / OI / PD / Site Map / Terms of Use / VA Privacy Policy / Accessibility

Reviewed/Updated: June 6, 2018

If you have questions, need more information, or are having accessibility problems with this website, please contact us by E-Mail: Webmasters, Phone: 510-768-6800, or FAX: 510-768-6850.