You are here: C++ API > Classes > dtsSearchResults Class > urlEncode Method > dtsSearchResults::urlEncode Method (int, int, int, int, const char *)
dtsSearchResults::urlEncode Method (int, int, int, int, const char *)
Close
dtSearch Text Retrieval Engine Programmer's Reference
dtsSearchResults::urlEncode Method (int, int, int, int, const char *)
Syntax
C++
dtsStringHandle urlEncode(int iItem, int maxLen, int aflags, int additionalSearchFlags, const char * indexId);
Parameters
Description
int iItem
Zero-based index identifying the item to encode
int maxLen
Maximum length of string to return, or zero to indicate no limit
int additionalSearchFlags
SearchFlags to use in addition to the ones used in the original search.
const char * indexId
A string value to use instead of the index path, which will be stored in the form ixid=indexId
flags
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.

Copyright (c) 1995-2022 dtSearch Corp. All rights reserved.