PhEventArm()

Arm the currently attached Photon channel

Synopsis:

int PhEventArm( void );

Library:

ph

Description:

This function arms the current Photon channel so that the channel will send a Neutrino pulse to the application when an event becomes available. If an event is already available, the pulse is sent immediately.

You must call this function before calling PhEventRead() for the first time.

Returns:

0: Successful completion.
-1: An error occurred.

Examples:

See PhEventRead().

Classification:

Photon

Safety:
Interrupt handler	No
Signal handler	No
Thread	No

See also:

PhAttach(), PhEventRead()

“Collecting events” in the Events chapter of the Photon Programmer's Guide