Legacy Document

Inside Macintosh: QuickDraw GX Environment and Utilities /

Chapter 2 - QuickDraw GX Memory Management / QuickDraw GX Memory Management Reference

Functions / Working With Multiple Graphics Clients

GXGetGraphicsClients

You can use the GXGetGraphicsClients function to list all of the graphics clients that have been allocated by QuickDraw GX.

long GXGetGraphicsClients(long index, long count, 
                        gxGraphicsClient clients[]);

index

The one-based index into the list of all graphics clients that indicates the first client to return.

count

The number of graphics clients to be returned.

clients

An array of graphics client references. On return, the array contains references to the allocated graphics clients.

function result

The number of graphics clients returned.

DESCRIPTION

The GXGetGraphicsClients function copies the graphics client references specified by the index and count parameters into the array. It will return the graphics clients that are owned by other applications in addition to the ones owned by the calling application. Specifying the value 1 for the index parameter returns the first client. Specifying the gxSelectToEnd constant for the count parameter returns all remaining graphics clients, starting with the indexed graphics client. If nil is passed for the clients parameter, no graphics clients are returned.

SEE ALSO

For additional information about graphics clients, see the section "About QuickDraw GX Memory Management" beginning on page 2-3.

Multiple graphics clients are discussed in the section"Working With Multiple Graphics Clients" beginning on page 2-16.