Carbon


GetControlPropertySize

Header: Controls.h Carbon status: Supported

Obtains the size of a piece of data that has previously been associated with a control.

OSStatus GetControlPropertySize (
    ControlRef control, 
    OSType propertyCreator, 
    OSType propertyTag, 
    UInt32 *size
);
control

A handle to the control whose associated data you wish to examine.

propertyCreator

Your program’s signature, as registered through Apple Developer Technical Support. If your program is of a type that would not normally have a signature (for example, a plug-in), you should still register and use a signature in this case, even though your program’s file may not have the same creator code as the signature that you register. The 'macs' property signature is reserved for the system and should not be used.

propertyTag

The application-defined code identifying the data.

size

On input, apointer to an unsigned 32-bit integer. On return, this value is set to the actual size of the data.

function result

A result code.

DISCUSSION

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

VERSION NOTES

This function is available with Mac OS 8.5 and later.

AVAILABILITY

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


© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)