dtsMessage Structure

Structure passed to dtsJobBase.pReportCallBack to implement status notification callbacks.

struct dtsMessage {
  intptr_t paramA;
  intptr_t paramB;
  const char * strParam;
  void * ptrParam;
  long result;
  long command;
};

File

dtsearch.h

Members

Members	Description
intptr_t paramA;	First integer parameter of the message
intptr_t paramB;	Second integer parameter of the message
const char * strParam;	String parameter of the message
void * ptrParam;	Pointer parameter of the message
long result;	Return value to pass back from the callback function
long command;	MessageCode value specifying the reason for the callback

Returns

pReportCallBack must return one of the following values:

Value	Meaning
dtsContinue	Continue to execute the job
dtsAbort	Cancel the job
dtsAbortImmediate	Cancel the job without saving changes to the index
dtsVetoSearchResultsItem	In response to dtsnSearchFound only, prevent this item from being included in search results.

During index updates, dtsAbort allows the current document to be completed and the information indexed so far to be committed to the index. dtsAbortImmediate cancels the index update and rolls back the index status to the last committed update.

Additional callbacks may occur after returning dtsAbort or dtsAbortImmediate.

Remarks

The meaning of the arguments depends on the "command" value, which is documented in the MessageCode enum.

For dtsnSearch* messages, msg.ptrParam points to a dtsSearchProgressInfo with information on the status of the search.

For dtsnIndex* messages, msg.ptrParam points to a dtsIndexProgressInfo with information on the status of the index update.

Other values in the dtsMessage are still supported for backwards compatibility and are used in the dtsfc.cpp source code for DSearchJob and DIndexJob, but these values are deprecated.

Group

Structs, Records, Enums

Links

Structs, Records, Enums