SendEvents
Top  Previous  Next

Description

Sends multiple event messages to the network.

[C++]
int
 SendEvents(unsigned int eventCount, unsigned short eventIds[], unsigned short channel = 0xFFFF, bool requireAck = true);

Parameters
[C/C++]
 
[in] unsigned short eventCount  
Integer value specifying the amount of events to be sent.  
 
[in] unsigned short eventIDs[]  
Integer array containing the numerical IDs of the events.  
 
[in] unsigned int channel  
Integer value specifying the index of the streaming channel associated with the events. Default value of 0xFFFF specifies that no streaming channel is involved.  

[in] bool requireAck  
If TRUE, the virtual camera will wait for the acknowledge reply from the GigE Vision client.  


Return Values

S_OK  
Success  
E_FAIL  
Failure  
 

Example


This fragment of code fires three event messages to the network:

unsigned short eventIDs[0x8E94,0x8E95,0x8E96];  
m_pCamera->SendEvents(3, eventIDs);  


Remarks

This method generates standard EVENT messages per GigE Vision specifications. It is typically associated with a certain action of the virtual camera of which a GigE Vision client should be notified. Each event will contain a timestamp indicating the exact time at which the event was generated. Depending on the Timer Mode, the timestamp will be reported either in the astronomical time or time elapsed from the start of the virtual camera application.

The channelIndex parameter should be used only if your virtual camera supports multiple streaming channels. For a regular GigE Vision transfer this parameter should remain in its default zero value.

If you want to associate your event messages with GenICam event features, you should call CreateEventCategory and CreateEvent prior to calling SendEvents.

Note that this method generates EVENT messages as opposed to EVENTDATA messages generated by SendEventData.