Legacy Document

Inside Macintosh: QuickDraw GX Environment and Utilities /

Chapter 1 - QuickDraw GX and the Macintosh Environment / QuickDraw GX and the Macintosh Environment Reference

Macintosh Interface Functions / Associating View Ports With Macintosh Windows

GXGetViewPortWindow

You can use the GXGetViewPortWindow function to return the Macintosh window of a specified view port.

gxWindowPtr GXGetViewPortWindow(gxViewPort portOrder);

portOrder

A reference to the specified view port.

function result

A pointer to the window associated with the specified view port.

DESCRIPTION

The function returns nil if the view port is not associated with a window.

This function returns nil if you pass it a reference to a child view port of a window view port. To determine the window ultimately associated with a child view port, use the GXGetViewPortParent function to find the parent view port at the top of the view port hierarchy, and pass that view port reference to the GXGetViewPortWindow function.

ERRORS, WARNINGS, AND NOTICES

Errors

out_of_memory

invalid_viewport_reference

SEE ALSO

To create a view port associated with a window, use the GXNewWindowViewPort function, described in the previous section. To obtain the view port associated with a window, use the GXGetWindowViewPort function, described next.