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 Kernel Toolkit Hypertext Transfer Protocol (HTTP) Client Helper software release adds a new tool in a set of Infrastructure software tools that developers can use. HTTP is a fast and reliable way for an application to collect data from another source. Kernel Toolkit Patch XT*7.3*123 allows VistA to tap into this information and retrieve Web data.

This code was developed by another VistA application that had a pressing need for this capability. The Kernel Toolkit development team is providing it as generic tool so that other developers may use its functionality for their needs. For example:

This extrinsic function returns an encoded query string used by the $$MAKEURL^XTHCURL API using the HTTP Client Helper 1.0 software. This API was introduced 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

string:

(required) Query string used by the $$MAKEURL^XTHCURL API.

Output

Returns:

Returns encoded string.

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: August 26, 2011

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.