prg_string_double_format()
摘要
返回 double 值的格式化字符串表示。
语法
prg_string_double_format (num, num_before, num_after, buf, options)
| 参数 | 类型 | 说明 |
|---|---|---|
num |
double |
要格式化的数值。 |
num_before |
int |
小数点之前允许的最大字符数(计入千位分隔符和正负号)。必须 >= 0。 |
num_after |
int |
小数点之后允许的字符数。必须 >= 0。注意:num_before 和 num_after 不能同时为 0。 |
buf |
char * |
用于填入格式化字符串的区域。该区域必须足够大以容纳返回的字符串;若函数成功(返回 PrgC_Compcode_Success),返回的字符串总是小于或等于请求的大小。请求的大小为 num_before + num_after(若 num_after > 0 则再 + 1 [小数点])。 |
options |
int |
double 的格式化选项(见 Details)。 |
返回类型
PrgT_Compcode
若 num 太大而无法满足 num_before 约束,或 buf 为 NIL,返回 PrgC_Compcode_Failure;否则返回 PrgC_Compcode_Success。
头文件
prg_string_funcs.h
详情
options 必须是 PRGC_STRING_FROM_DOUBLE_NONE,或以下一个或多个符号常量的 OR 组合:
- PRGC_STRING_FROM_DOUBLE_NO_THOUSAND_SEPARATOR—字符串中不包含千位分隔符字符。
- PRGC_STRING_FROM_DOUBLE_EXCLUDE_MINUS_SIGN—负数不包含负号。
- PRGC_STRING_FROM_DOUBLE_INCLUDE_PLUS_SIGN—正数包含正号。
- PRGC_STRING_FROM_DOUBLE_PAD_LEAD_SPACES—添加前导空格,使小数点左侧的总字符数(计入千位分隔符和正负号)等于 num_before。
- PRGC_STRING_FROM_DOUBLE_PAD_TRAIL_SPACES—添加尾随空格,使小数点右侧的总字符数等于 num_after。
- PRGC_STRING_FROM_DOUBLE_PAD_TRAIL_ZEROS—添加尾随零,使小数点右侧的总字符数等于 num_after。
- PRGC_STRING_FROM_DOUBLE_REPRESENT_APPROXIMATED_ZERO—在接近零的数值前添加波浪号(‘~’)(即当 num 小到 num_after 约束只会使格式化字符串中全为零的情况)。“接近”定义为 num < 0.5 × 10^–num_after。
- PRGC_STRING_FROM_DOUBLE_REMOVE_TRAIL_ZEROS—移除所有尾随零。
格式说明
- 必要时对格式化数值进行四舍五入。
- 若 0 <= |num| < 1,小数点前会出现一个零(除非 num_before 为 0)。
- 若 num_after 为 0,字符串中不包含小数点。
- 若 num 是符号值(如 PRGC_DBL_UNDEF),则在 buf 中返回该符号名称(此例中为 “Undefined”)。名称字符串会用空格填充(若 options 要求)至请求的字符串长度,即 num_before + num_after(若 num_after > 0 则再 + 1)。若同时要求前导和尾随空格,名称将在填充后的字符串中居中。