  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The GetRedValue function retrieves the red component from an RGB dword or string value.
Syntax/Parameters
Syntax
byte = GetRedValue ( dword data );
int = GetRedValue ( string data );
Parameters
data
A dword representing a 24-bit RGB value or
a string as RGB hex (#rrggbb, #rtb), RGB CSS ( rgb(rrr,ggg,bbb) ), or a web standard color name.
Return Value
Returns a byte representing the red color.
Remarks
The GetRedValue function returns the 8 bits (byte) of a 24-bit color value that represents the red portion. The version of this function that accepts a dword as the input parameter does not return an error while the version that takes a string will return -1 on a syntax error or bad color name. If a byte is used to store the return value for the string version, -1 will be truncated to 0xFF with a runtime warning. Either way, use the IsError or GetLastError function to determine if an error occurred.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.