MCS_getControlMax

Returns the maximum value for an MCCS control

Declaration

ibool NAPI MCS_getControlMax(
uchar controlCode,
ushort *max)

Prototype In

snap/ddc.h

Parameters

controlCode | MCCS control code (MCS_controlsType)
max | Place to store the maximum value for the control

Return Value

True if the function succeeded, false if it failed.

Description

This function obtains the maximum value for a specified MCCS control for the attached monitor. Continuous controls may accept any value between zero and the maximum value, specific to each control. Non-continuous controls can only accept specific values. The maximum value returned for non-continuous controls represents the maximum index for the acceptable values for the control. A value of 0 for non-continous controls represents that no value has been selected.

Note: This function internally reads the maximum value from the attached monitor only once for each control between an MCS_begin and MCS_end block. If you call it again after the maximum value for a control has been read, it simply returns an internal cached value for maximum performance.

See Also

MCS_isControlSupported, MCS_enableControl, MCS_getControlValue, MCS_setControlValue, MCS_resetControl, MCS_saveCurrentSettings

Copyright © 2002 SciTech Software, Inc. Visit our web site at http://www.scitechsoft.com