DesktopFrequency()

Syntax

Result = DesktopFrequency(#Desktop)

Returns the frequency of the specified desktop.

Parameters

#Desktop

The index of the desktop. The first index always specifies the primary monitor. The first index value is zero.

Return value

Returns the frequency of the specified desktop in Hertz. If the return-value is 0 then the default hardware frequency is being used, or the actual frequency could not be determined.

Remarks

ExamineDesktops() must be called before using this function to retrieve information about the available desktops. Note: on Linux, this function always returns 0.

Example

  ExamineDesktops()
  f = DesktopFrequency(0)
  If f = 0
    MessageRequester("Display Information", "There isn't set any desktop frequency, the standard hardware frequency is used.")
  Else
    MessageRequester("Display Information", "Frequency of desktop: "+Str(f)+" Hz.")
  EndIf

See Also

ExamineDesktops(), DesktopDepth(), DesktopHeight(), DesktopName(), DesktopWidth()

Supported OS

Windows, MacOS X