JET_PFNSTATUS Callback Function

Article
08/26/2021

Applies to: Windows | Windows Server

JET_PFNSTATUS Callback Function

The JET_PFNSTATUS callback function receives information about the progress of long-running operations, such as defragmentation, backup, or restore operations. During such operations, the database engine calls this callback function to give an update on the progress of the operation.

    JET_ERR JET_API JET_PFNSTATUS(
                           JET_SESID  sesid,
                           JET_SNP snp,
                           JET_SNT snt,
                           void* pv
    );

Parameters

sesid

The session of type JET_SESID with which the long-running function was called.

snp

The type of operation as specified in JET_SNP. Types of operations include repair, compact, restore, backup, update, scrub, and update the record format.

snt

The status of an operation. Status types include beginning, in progress, completion, or failure. The status will be specified with the third parameter of type JET_SNT.

An optional pointer to a structure of type JET_SNPROG.

Return Value

This function returns the JET_ERR datatype with one of the Extensible Storage Engine error codes. For more information about the possible ESE errors, see Extensible Storage Engine Errors and Error Handling Parameters.

On success, the operation that issued the callback can proceed normally. In some cases, the callback might return a warning that influences that operation.

On failure, the operation that issued the callback might proceed normally or might fail.

Remarks

This callback function will be used in a progress notification in which the structure will indicate the current state of the progress. Note that the callback function might be called multiple times for the progress of the operation.

Requirements

Requirement	Value
Client	Requires Windows Vista, Windows XP, or Windows 2000 Professional.
Server	Requires Windows Server 2008, Windows Server 2003, or Windows 2000 Server.
Header	Declared in Esent.h.

Share via

JET_PFNSTATUS Callback Function