LVectorBase::Event

#include "ltvkrn.h"

virtual L_INT LVectorBase::Event(pEvent)

Implements a user-defined event.

Parameters

pVECTOREVENT pEvent

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

Returns

Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

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

See Also

Functions

Topics

Example

For an example, refer to LVectorBase::VectorEventProcCallBack.

Help Version 21.0.2021.4.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Vector C++ Class Library Help