Read-Only Variables Available in .Htx Files

Note

Indexing Service is no longer supported as of Windows XP and is unavailable for use as of Windows 8. Instead, use Windows Search for client side search and Microsoft Search Server Express for server side search.

 

The following variables are available for use in .htx files. These are set based upon the results of the search. In addition, the other .idq variables mentioned below can be used in the .htx file. In the detail section of the .htx file, any output columns mentioned in the CiColumns parameter can also be used.

Variable Name Meaning
CiBookmark Reference to the first row on the page.
CiContainsFirstRecord Set to 1 if this page contains the first record of the query results; 0 otherwise.
CiContainsLastRecord Set to 1 if this page contain the last record of the query results; 0 otherwise. For a sequential query, this will not be accurate until after the <%enddetail%>section in the .htx file.
CiCurrentPageNumber Current page number of query results (that is, page number x of y pages).
CiCurrentRecordNumber Number displayed for current record.
CiErrorMessage Error message. Available only for error pages. See Error Messages and Error Pages for possible error messages.
CiErrorNumber Error number. Available only for error pages.
CiFirstRecordNumber Record number of first record on a page.
CiLastRecordNumber Last record number on a page. For a sequential query, this will not be accurate until after the <%enddetail%> section in the .htx file.
CiMatchedRecordCount Total number of records matching a query. Referring to this variable from the .htx file will force the search to use a nonsequential query.
CiOutOfDate Set to 1 if the content index is out of date; 0 otherwise.
CiQueryIncomplete Set to 1 if the query could not be resolved using the content index and CiForceUseCI was set; 0 otherwise.
CiQueryTimedOut Set to 1 if the query exceeded the time limit for execution; 0 otherwise.
CiQueryDate Date (at the web server) the query was executed.
CiQueryTime Time (at the web server) the query was executed.
CiQueryTimeZone Time zone of the web server.
CiRecordsNextPage Number of records on the next page. Referring to this variable from the .htx file will force the search to use a nonsequential query.
CiTotalNumberPages Total number of pages used to contain query results. Referring to this variable from the .htx file will force the search to use a nonsequential query.
CiVersionMajor The major version of Indexing Service.
CiVersionMinor The minor version of Indexing Service.