You are here: C++ API > Classes > dtsSearchResults Class > urlEncode Method > dtsSearchResults::urlEncode Method (int, char *, ptrdiff_t)
Close
dtSearch Text Retrieval Engine Programmer's Reference
Contents|Index|Home
Previous|Up|Next
dtsSearchResults::urlEncode Method (int, char *, ptrdiff_t)
dtsSearchResults Class
Syntax
C++
int urlEncode(int iItem, char * dest, ptrdiff_t maxLen);

urlEncode Method

Parameters
Description
int iItem
Zero-based index identifying the item to encode
char * dest
Buffer to receive the url-encoded item
ptrdiff_t maxLen
Size of the buffer (at least 1024 bytes is recommended)

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.

If the buffer is not large enough to store all of the hit offsets, a partial list of hit offsets will be stored.

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