LVectorBase::Event

Summary

Implements a user-defined event.

Syntax

virtual L_INT LVectorBase::Event(pEvent)

Parameters

pVECTOREVENT pEvent

Pointer to a VECTOREVENT structure that describes the event that has occurred inside the vector handle.

Returns

Comments

This function provides a means of grouping numerous operations into one event. This function must be called twice. In the first call to this function the Status member of the VECTOREVENT structure must be set to VECTOR_EVENT_STATUS_BEFORE. This allows any callback currently installed to cancel the operation. The return value for this function will be the return value of the callback function.

The second call to this function is made after the operation(s) have been completed. The Status member of the VECTOREVENT structure must be set to VECTOR_EVENT_STATUS_AFTER to notify the vector toolkit that the operation(s) have been completed successfully.

For information on the types of events the vector handle can generate, refer to the VECTOREVENT structure.

Required DLLs and Libraries

• LTVKRN
• For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions

• LVectorBase::VectorEventProcCallback

Topics

• Vector Handle Events

Example

For an example, refer to LVectorBase::VectorEventProcCallBack.