Carbon


GetControlViewSize

Header: Controls.h Carbon status: Supported

Obtains the size of the content to which a control’s size is proportioned.

SInt32 GetControlViewSize (
    ControlRef theControl
);
Parameter descriptions
theControl

A value of type ControlHandle. Pass a handle to the control whose view size you wish to obtain.

function result

A value equal to the current size of the content being displayed, expressed in terms of the same units of measurement as are used for the minimum, maximum, and current settings of the control.

DISCUSSION

Your application should call the GetControlViewSize function to obtain the current view size of a control. This value is used by the function SetControlViewSize to support proportional scroll boxes.

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)