qb64/internal/help/_HEIGHT.md at c7bfef667f23cb8929bfce62ea064367928e4c0c

QB64/qb64

mirror of https://github.com/QB64Official/qb64.git synced 2024-07-07 20:20:25 +00:00

Cory Smith 3ff2da7d90 Swapping out txt help files in favor of md files.

2022-09-02 17:04:18 -05:00

The _HEIGHT function returns the height of an image handle or of the current write page.

Syntax

columns& = _HEIGHT[(imageHandle&)]

If imageHandle& is omitted, it's assumed to be the handle of the current SCREEN or write page.
To get the height of the current program SCREEN window use zero for the handle value or nothing: lines& = _HEIGHT(0) or lines& = _HEIGHT
If the image specified by imageHandle& is in text only (SCREEN 0) mode, the number of characters per row is returned.
If the image specified by imageHandle& is in graphics mode, the number of pixels per row is returned.
If imageHandle& is an invalid handle, then an ERROR Codes is returned.
The last visible pixel coordinate of a program SCREEN is _HEIGHT - 1.