You are here: C++ API > Classes > dtsSearchResults Class > urlEncode Method > dtsSearchResults::urlEncode Method (int, int, int)
dtSearch Text Retrieval Engine Programmer's Reference
dtsSearchResults::urlEncode Method (int, int, int)
dtsStringHandle urlEncode(int iItem, int maxLen, int aflags);
int iItem
Zero-based index identifying the item to encode
int maxLen
Maximum length of string to return, or zero to indicate no limit
UrlEncodeItemFlags value specifying options for the URL encoding

A dtsStringHandle with the result of the URL encoding

urlEncode generates a string encoding the contents of the currently selected item in search results. The string can be used in a subsequent call to urlDecode to re-create the search results item.

The limit in maxLen is ignored if dtsUrlEncodeAsSearch is set in flags.