Image Manager (CVCDriver.dll) 15.0
IPropertyChange

Interface for being notified when a driver property is changed. More...

Typedefs

typedef cvbbool_t __stdcall * CVBDRIVER_PROPERTYCHANGE_CB(IMAGEPROPCHANGE_REASON ReasonForCall, IMAGEPROPCHANGE_ANSWER &Answer, void *pPrivate, cvbval_t Reserved1, cvbval_t Reserved2)
 

Enumerations

enum  IMAGEPROPCHANGE_ANSWER { IMAGEPROPCHANGE_ANSWER_OK = 0 , IMAGEPROPCHANGE_ANSWER_CANCEL = 1 }
 IMAGEPROPCHANGE_ANSWER enumerated values can be used in your implementation of a CVBDRIVER_PROPERTYCHANGE_CB callback to signal to the calling driver how to proceed with a requested property change. More...
 
enum  IMAGEPROPCHANGE_REASON { IMAGEPROPCHANGE_REASON_BFORE_IMAGE_CHANGE = 0 , IMAGEPROPCHANGE_REASON_AFTER_IMAGE_CHANGE = 1 , IMAGEPROPCHANGE_REASON_NEW_IMAGESIZE = 2 , IMAGEPROPCHANGE_REASON_TIMEOUT = 3 }
 IMAGEPROPCHANGE_REASON is used in the IPropertyChange interface for communicating the context of the invocation of the CVBDRIVER_PROPERTYCHANGE_CB callback. More...
 

Functions

cvbbool_t CanPropertyChange (IMG Image)
 This function verifies whether the image supports the PropertyChange interface. More...
 
cvbres_t PCRegisterCallBack (IMG Image, CVBDRIVER_PROPERTYCHANGE_CB pDriverCB, void *pPrivate)
 Registers a callback function that is called by the driver on changes of properties. More...
 
cvbres_t PCUnRegisterCallBack (IMG Image, CVBDRIVER_PROPERTYCHANGE_CB pDriverCB)
 Unregisters a previously registered callback function. More...
 

Detailed Description

Interface for being notified when a driver property is changed.

Typedef Documentation

◆ CVBDRIVER_PROPERTYCHANGE_CB

typedef cvbbool_t __stdcall * CVBDRIVER_PROPERTYCHANGE_CB(IMAGEPROPCHANGE_REASON ReasonForCall, IMAGEPROPCHANGE_ANSWER &Answer, void *pPrivate, cvbval_t Reserved1, cvbval_t Reserved2)

Attention
The list below descripes the specific constant declarations and typedefs. There are declared in the header file iCVCDriver.h.
Parameters
[in]ReasonForCall
[out]Answer
[in]pPrivatePointer to private data (e.g. class pointer) which is passed to the callback functions.
[in]Reserved1
[in]Reserved2
Returns
TRUE if succeeded, otherwise FALSE.
Supported platforms:
Win32
Win64
Linux

Enumeration Type Documentation

◆ IMAGEPROPCHANGE_ANSWER

IMAGEPROPCHANGE_ANSWER enumerated values can be used in your implementation of a CVBDRIVER_PROPERTYCHANGE_CB callback to signal to the calling driver how to proceed with a requested property change.

Attention
The list below describes the specific constant declarations and typedefs. These are declared in the header file iCVCDriver.*.
Enumerator
IMAGEPROPCHANGE_ANSWER_OK 

Return this value in the CVBDRIVER_PROPERTYCHANGE_CB call to let the calling driver know that a property change is acceptable.

IMAGEPROPCHANGE_ANSWER_CANCEL 

Return this value in the CVBDRIVER_PROPERTYCHANGE_CB call to let the calling driver know that a property change is to be canceled.

◆ IMAGEPROPCHANGE_REASON

IMAGEPROPCHANGE_REASON is used in the IPropertyChange interface for communicating the context of the invocation of the CVBDRIVER_PROPERTYCHANGE_CB callback.

Attention
The list below describes the specific constant declarations and typedefs. These are declared in the header file iCVCDriver.* .
Enumerator
IMAGEPROPCHANGE_REASON_BFORE_IMAGE_CHANGE 

callback is invoked before an image property is about to change

IMAGEPROPCHANGE_REASON_AFTER_IMAGE_CHANGE 

callback is invoked after an image property has changed

IMAGEPROPCHANGE_REASON_NEW_IMAGESIZE 

callback is invoked after the size of an image has changed

IMAGEPROPCHANGE_REASON_TIMEOUT 

callback is invoker after an acquisition timed out

Function Documentation

◆ CanPropertyChange()

cvbbool_t CanPropertyChange ( IMG  Image)

This function verifies whether the image supports the PropertyChange interface.

Parameters
[in]ImageHandle of image object.
Returns
TRUE if the image supports the PropertyChange interface, FALSE otherwise.
Supported platforms:
Win32
Win64
Linux
Examples:
Visual C++ - VC MDI Example (DLL only)

◆ PCRegisterCallBack()

cvbres_t PCRegisterCallBack ( IMG  Image,
CVBDRIVER_PROPERTYCHANGE_CB  pDriverCB,
void *  pPrivate 
)

Registers a callback function that is called by the driver on changes of properties.

A registered callback function must be unregistered using the PCUnRegisterCallBack function.

Parameters
[in]ImageHandle of image object.
[in]pDriverCBPointer to the callback function of the type CVBDRIVER_PROPERTYCHANGE_CB.
[in]pPrivatePointer to private data (e.g. class pointer) which is passed to the callback functions.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux
Examples:
Visual C++ - VC MDI Example (DLL only)

◆ PCUnRegisterCallBack()

cvbres_t PCUnRegisterCallBack ( IMG  Image,
CVBDRIVER_PROPERTYCHANGE_CB  pDriverCB 
)

Unregisters a previously registered callback function.

Parameters
[in]ImageHandle of image object.
[in]pDriverCBPointer to the callback function of the type CVBDRIVER_PROPERTYCHANGE_CB.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux
Examples:
Visual C++ - VC MDI Example (DLL only)