Carbon


GetWindowPropertySize

Header: MacWindows.h Carbon status: Supported

Obtains the size of a piece of data that is associated with a window.

OSStatus GetWindowPropertySize (
    WindowRef window, 
    PropertyCreator creator, 
    PropertyTag tag, 
    UInt32 *size
);
Parameter descriptions
window

A pointer to the window to be examined for associated data.

creator

The creator code (typically, the application’s signature) of the associated data whose size is to be obtained.

tag

The application-defined code identifying the associated data whose size is to be obtained.

size

A pointer to a value that, on return, specifies the size of the associated data.

function result

A result code.

DISCUSSION

If you want to retrieve a piece of associated data with the GetWindowProperty function, you typically need to use the GetWindowPropertySize function to determine the size of the data beforehand.

VERSION NOTES

This function is available with Mac OS 8.5 and later.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.5 or later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)