  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The IntegerToBinaryUnits function converts an unsigned integer value into a string scaled by binary units.
Syntax/Parameters
Syntax
string = IntegerToBinaryUnits ( qword value, [dword options] );
Parameters
value
An unsigned integer value (up to a 64-bit qword) as the source value.
options
An optional dword value as bitwise flags to direct the conversion of binary unit value. See the IntegerToBinaryCombo function for a list of the optional flags.
Return Value
Returns a string containing the unit conversion of the provided value.
Remarks
The IntegerToBinaryUnits function is part of a series of functions that provide for the conversion of an integer to a binary or computer display versions of size. For example, 1,048,576 bytes is “1mb” in unit convention. Unlike the IntegerToBinaryCombo function, the IntegerToBinaryUnits function does not add in the total bytes as part of the return string.
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.