gobj_event_type()

gobj_event_type()#

Retrieves the event type information for a given event in the specified gobj. If the event is not found in the gobj’s event list, it checks the global event list if include_system_events is set to true.

Prototype

PUBLIC event_type_t *gobj_event_type(
    hgobj gobj_,
    gobj_event_t event,
    BOOL include_system_events
);

Parameters

Key

Type

Description

gobj_

hgobj

The gobj in which to search for the event.

event

gobj_event_t

The event whose type information is to be retrieved.

include_system_events

BOOL

If true, the function also checks the global event list for the event.


Return Value

A pointer to the event_type_t structure describing the event if found, or NULL if the event is not found.

Notes

If include_system_events is set to true, the function will also check the global event list for system events.

Prototype

// Not applicable in JS

Prototype

# Not applicable in Python
Examples
// TODO C examples
// TODO JS examples
# TODO Python examples