PtForwardWindowTaskEvent()

Forward a window event to the task with a given Photon connection ID

Synopsis:

int PtForwardWindowTaskEvent( 
       PhConnectId_t task, 
       PhWindowEvent_t const *evt);

Library:

ph

Description:

This function forwards a window event to the task with a given Photon connection ID. It's similar to PtForwardWindowEvent().

You can get the Photon connection ID from the information that you get from PhGetConnectInfo(). PtForwardWindowTaskEvent() forwards the event to the main window for the task.

In addition to the window-event types described for the PhWindowEvent_t structure, you can specify a special pseudo-event, Ph_WM_SUPERSELECT. If you forward this type of event to a task, the window manager moves the window and any child windows to the current console, puts them in front of any other windows, and gives focus to the first nonblocked window.

Returns:

0

Success.

-1

An error occurred.

Examples:

See “Getting and setting the window state” in the Window Management chapter of the Photon Programmer's Guide.

Classification:

Photon

See also:

PhGetConnectId(), PhGetConnectInfo(), PhWindowEvent_t, PtForwardWindowEvent()

PtWindowFocus(), PtWindowToBack(), PtWindowToFront() in the Photon Widget Reference

“Getting and setting the window state” in the Window Management chapter of the Photon Programmer's Guide.