Legacy Document

Inside Macintosh: Macintosh Toolbox Essentials /

Chapter 5 - Control Manager / Control Manager Reference

Control Manager Routines / Determining Control Values

GetAuxiliaryControlRecord

Use the GetAuxiliaryControlRecord function to get a handle to a control's auxiliary control record. The GetAuxiliaryControlRecord function is also
available as the GetAuxCtl function.

FUNCTION GetAuxiliaryControlRecord (theControl: ControlHandle;
                                    VAR acHndl: AuxCtlHandle)
                                    : Boolean;

theControl

A handle to a control.

acHndl

A handle to the auxiliary control record for the control.

DESCRIPTION

In its acHndl parameter, the GetAuxiliaryControlRecord function returns a handle to the auxiliary control record for the specified control. Your application typically doesn't need to access an auxiliary control record unless you need its acRefCon field, which your application can use for any purpose.

The value that GetAuxiliaryControlRecord returns for a function result depends on the control's color control table, as described here:

• If your application has changed the default control color table for the given control (either by using the SetControlColor procedure or by creating its own control color table), the function returns TRUE.
• If your application has not changed the default control color table, the function
  returns FALSE.
• If you set the parameter theControl to NIL, the Dialog Manager ensures that
  the control uses the default color table, and GetAuxiliaryControlRecord
  returns TRUE.