DBBreak

Halt execution of a query

#include <DatabaseAccess.h> Data Access Manager

OSErr DBBreak( sessID, abort, asyncPB);

long sessID ; is the session ID

Boolean abort; TRUE ( nonzero), halts any query and

terminates current session

DBAsyncParmBlkPtr asyncPB; is a pointer to the asynchronous parameter

block

returns Error Code; 0=no error

The DBBreak function can halt execution of a query and reinitialize the data

server, or it can unconditionally terminate a session with a data server. You

can use this function to cancel a query if you determine that it is taking too

long to complete execution, for example.

sessID is the session ID that was returned by the DBInit function.

abort If the abort parameter is TRUE ( nonzero), the data server halts any

query that is executing and terminates the current session. If the

abort parameter is FALSE (0), the data server halts any query that

is executing and re initializes itself.

asyncPB is a pointer to the asynchronous parameter block. If you do not want

to call the function asynchronously, set this parameter to NIL.

Returns: an operating system Error Code.

noErr (0) Execution has begun

rcDBError (-802) Break or abort attempt was un successful

rcDBBadSessID -(806) Session ID is invalid

rcDBAsyncNotSupp (-809) The database extension does not support asynchronous

calls

rcDBPackNotInited (-813) The InitDBPack function has not yet been called

Referenced by (1):