Kernel Toolkit APIs: $$ENCODE^XTHCURL

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

Reference Type: Supported, Category: Toolkit—HTTP Client Helper, ICR#: 5554

Description

The $$ENCODE^XTHCURL extrinsic function encodes the query string. The $$MAKEURL^XTHCURL 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(str)

Input Parameters

str:

(required) String of data to be encoded.

Output

returns:

Returns:

Success: Encoded query string.
Fail: -1^String not defined (if missing str parameter).

Example:

W $$ENCODE^XTHCURL("123+main+st.,Anycity,CA")
123%2Bmain%2Bst.%2CAnycity%2CCA