Legacy Document

Inside Macintosh: QuickDraw GX Environment and Utilities /

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

Functions / Loading and Unloading Objects

GXUnloadInk

You can use the GXUnloadInk function to unload an ink from memory.

void GXUnloadInk(gxInk target);

target

A reference to the ink object to be unloaded from memory.

DESCRIPTION

The GXUnloadInk function moves an ink object from the active graphics client heap to disk storage. When you or QuickDraw GX use the GXUnloadInk function to unload an ink object from memory to disk storage, QuickDraw GX stores its location in a 4-byte stub in the active graphics client heap. When you use the GXLoadInk function to reload the object from disk storage to memory, QuickDraw GX uses the stub to find the stored ink object.

ERRORS, WARNINGS, AND NOTICES

Errors

out_of_memory

ink_is_nil

SEE ALSO

For additional information about loading objects from disk storage to memory and unloading objects from memory to disk storage, see the section "Loading and Unloading Objects" beginning on page 2-12.

The GXLoadInk function is described in the previous section.