mirror of
https://github.com/QB64-Phoenix-Edition/QB64pe.git
synced 2024-07-03 13:31:23 +00:00
35 lines
1.2 KiB
Plaintext
35 lines
1.2 KiB
Plaintext
{{DISPLAYTITLE:_HEIGHT}}
|
|
The [[_HEIGHT]] function returns the height of an image handle or current write page.
|
|
|
|
|
|
{{PageSyntax}}
|
|
:''result&'' = {{KW|_HEIGHT}}[({{Parameter|imageHandle&}})]
|
|
|
|
|
|
{{PageDescription}}
|
|
* If {{Parameter|imageHandle&}} is omitted, it's assumed to be the handle of the current write page.
|
|
* To get the width of the current program window use zero for the handle value: depth& = _HEIGHT(0)
|
|
* If the image specified by {{Parameter|imageHandle&}} is in text mode, the number of characters per column is returned.
|
|
* If the image specified by {{Parameter|imageHandle&}} is in graphics mode, the number of pixels per column is returned.
|
|
* If {{Parameter|imageHandle&}} is an invalid handle, then an [[ERROR Codes|invalid handle]] error will occur.
|
|
* The maximum pixel coordinate of a program [[SCREEN|screen]] is one less than what the function returns.
|
|
|
|
|
|
''Example:'' Displays the current program window area.
|
|
{{CodeStart}} '' ''
|
|
{{Cl|SCREEN}} 12
|
|
wide = {{Cl|_WIDTH (function)|_WIDTH}}
|
|
deep = {{Cl|_HEIGHT}}
|
|
|
|
{{Cl|PRINT}} "The program screen is"; wide; "X"; deep '' ''
|
|
{{CodeEnd}}
|
|
|
|
|
|
{{PageSeeAlso}}
|
|
* [[_WIDTH (function)]]
|
|
* [[_LOADIMAGE]]
|
|
* [[_FONTHEIGHT]]
|
|
* [[Bitmaps]]
|
|
|
|
|
|
{{PageNavigation}} |