:man| Alphabetical   Categories   About us 
 
HUMANIZE_NUMBER (3) | C library functions | Unix Manual Pages | :man

NAME

humanize_number - format a number into a human readable form

CONTENTS

Library
Synopsis
Description
Return Values
History

LIBRARY


.Lb libutil

SYNOPSIS


.In libutil.h int
.Fo humanize_number "char *buf" "size_t len" "int64_t number" "const char *suffix" "int scale" "int flags"
.Fc

DESCRIPTION

The humanize_number function formats the signed 64-bit quantity given in number into buffer. A space and then suffix is appended to the end. The buffer pointed to by buffer must be at least len bytes long.

If the formatted number (including suffix) would be too long to fit into buffer, then divide number by 1024 until it will. In this case, prefix suffix with the appropriate SI designator.

The prefixes are:

"Prefix" "Description" "Multiplier"
k kilo 1024
M mega 1048576
G giga 1073741824
T tera 1099511627776
P peta 1125899906842624
E exa 1152921504606846976

The len argument must be at least 4 plus the length of suffix, in order to ensure a useful result is generated into buffer. To use a specific prefix, specify this as scale (multiplier = 1024 ^ scale). This cannot be combined with any of the scale flags below.

The following flags may be passed in scale:

HN_AUTOSCALE Format the buffer using the lowest multiplier possible.
HN_GETSCALE Return the prefix index number (the number of times number must be divided to fit) instead of formatting it to the buffer.

The following flags may be passed in flags:

HN_DECIMAL If the final result is less than 10, display it using one digit.
HN_NOSPACE Do not put a space between number and the prefix.
HN_B Use ‘B’ (bytes) as prefix if the original result does not have a prefix.
HN_DIVISOR_1000 Divide number with 1000 instead of 1024.

RETURN VALUES

The humanize_number function returns the number of characters stored in buffer (excluding the terminating NUL) upon success, or -1 upon failure. If HN_GETSCALE is specified, the prefix index number will be returned instead.

HISTORY

The humanize_number function first appeared in
.Nx 2.0 .

May 25, 2004 HUMANIZE_NUMBER (3)
shtml">manServer 1.07 from humanize_number.3 using doc macros.


Share this page

     Follow us

Facebook Twitter Google+ LinkedIn


 
Created by Blin Media, 2008-2013