Format - C++ Builder

C++ Builder 参考手册 ➙ System::Sysutils ➙ Format


格式化输出到字符串

头文件:#include
命名空间:System::Sysutils
函数原型:

System::UnicodeString __fastcall Format(
    const System::UnicodeString Format,
    const System::TVarRec *Args,
    const int Args_High);

System::UnicodeString __fastcall Format(
    const System::UnicodeString Format,
    const System::TVarRec *Args,
    const int Args_High,
    const TFormatSettings &AFormatSettings);

template ::type>::value>::type>
System::String Format(const char *fmt, const Args&... args)
{
    System::TVarRec arg_list[] = {args...};
    return Format(System::String(fmt), arg_list, sizeof...(Args)-1);
}

template ::type>::value>::type>
System::String Format(const System::WideChar *fmt, const Args&... args)
{
    System::TVarRec arg_list[] = {args...};
    return Format(System::String(fmt), arg_list, sizeof...(Args)-1);
}

参数:

  • Format:格式字符串;
  • Args:要输出的数据;
  • Args_High:数据的个数减1;
  • fmt:格式字符串;
  • args:要输出的数据,
    可变参数的函数模板需要 C++ 11 及更新的编译器支持,
    老版本 Borland 编译器只能用含有 System::TVarRec * 类型参数的函数;
  • AFormatSettings:地区格式;

返回值:

  • 按照参数 fmt 或 Format 的格式生成字符串,函数返回生成的字符串:
    格式和 里面的 printf / sprintf 类似,不完全一样,详见后面的格式描述和表格;
    如果格式解析错误,会抛出 EConvertError 异常,而不是像 printf / sprintf 那样得到错误的结果;
    和 printf / sprintf 另一个不同:Format 函数使用地区格式,而 printf / sprintf 不使用地区格式;
  • 参数 Args, Args_High 可以使用 ARRAYOFCONST 宏;
  • 地区格式的例子请参考 FloatToStrF
    如果有 AFormatSettings 参数,使用这个参数的格式;
    如果没有 AFormatSettings 参数,使用 全局变量 System::Sysutils::FormatSettings 作为地区格式;
  • 没有 AFormatSettings 参数的函数不是线程安全的,因为使用了全局变量作为地区格式;带有 AFormatSettings 参数的函数是线程安全的。

格式字符串的格式:"%" [index ":"] ["-"] [width] ["." prec] type
格式说明符以百分号 % 开头,接下来的内容按顺序为:

  • (可选) 参数序号,后面跟着冒号 ":"
  • (可选) 左对齐说明符,减号 "-"
  • (可选) 宽度,直接写数字
  • (可选) 精度说明符,小数点 "." 精度数字
  • (必选) 输出参数的类型说明符
类型说明符 描述
d 十进制 (decimal) 对应的参数必须是整数,
如果包含精度说明,表示输出整数至少要有多少位,位数不足前面补 0
u 无符号十进制 (unsigned decimal),其他描述同 d
e 科学计数法 (scientific),对应的参数必须是浮点数,
例如 -1.23456E+789 这样的格式,表示 -1.23456×10789
f 固定位数的小数 (fixed),对应的参数必须是浮点数,
精度表示小数点后面的位数,如果没指定精度,小数点后保留2位小数
g 综合的 (general),对应的参数必须是浮点数,
采用小数或科学计数法,让输出最短,
如果没指定精度,按15处理,
小数点之后的末尾的0不输出
n 带千分位分割符的数字 (number),对应的参数必须是浮点数,
其他描述同 f,例如 1,234,567.89
m 货币 (money),与 n 的区别:使用的是地区格式当中货币相关的成员
CurrencyString, CurrencyFormat, NegCurrFormat,
ThousandSeparator, DecimalSeparator, CurrencyDecimals 等
p 指针 (pointer),对应的参数必须是指针类型,输出指针的地址
s 字符串 (string),精度表示最长输出,超过的部分不输出
x 十六进制 (hexadecimal),对应的参数必须是整数,
精度表示输出的位数,不足位数前面补0
  • 类型说明符大写和小写都可以,不影响输出。
  • 浮点数和货币类型使用地区格式,请参考 FloatToStrF 地区格式的说明和例子
  • 参数序号、宽度和精度可以直接用数字,例如 "%10d",也可以用星号 '*',如果使用了星号,数值从参数里面读取,例如 Format('%*.*f', 8, 2, 123.456) 相当于 Format('%8.2f', 123.456)
  • 宽度表示输出的位数,默认为右对齐,如果宽度是负数表示左对齐,对齐是用空格补足宽度的;
  • 格式里面的参数序号影响从这个参数开始以后的参数,从这个序号开始往下排,一直到遇到下一个指定的参数序号,例如 "Format('%d %d %0:d %d', 10, 20)" 返回生成的字符串为 "10 20 10 20"

相关:

  • System::Sysutils::Format
  • System::Sysutils::FormatBuf
  • System::Sysutils::FormatCurr
  • System::Sysutils::FormatDateTime
  • System::Sysutils::FormatFloat
  • System::Sysutils::FmtStr
  • System::Sysutils::FmtLoadStr
  • System::Sysutils::StrFmt
  • System::Sysutils::StrLFmt
  • System::Sysutils::WideFormat
  • System::Sysutils::WideFormatBuf
  • System::Sysutils::WideFmtStr
  • System::Sysutils
  • std::printf, std::_tprintf, std::wprintf
  • std::sprintf, std::_stprintf, std::swprintf
  • std::vprintf, std::_vtprintf, std::vwprintf
  • std::vsprintf, std::_vstprintf, std::vswprintf
  • std::snprintf, std::_sntprintf, std::snwprintf
  • std::vsnprintf, std::_vsntprintf, std::vsnwprintf

C++ Builder 参考手册 ➙ System::Sysutils ➙ Format

你可能感兴趣的:(Format - C++ Builder)