System.AnsiStrings.FormatBuf

提供:RAD Studio API Documentation

Delphi

function FormatBuf(var Buffer; BufLen: Cardinal; const Format;
FmtLen: Cardinal; const Args: array of const): Cardinal;
function FormatBuf(var Buffer; BufLen: Cardinal; const Format;
FmtLen: Cardinal; const Args: array of const;
const AFormatSettings: TFormatSettings): Cardinal;

C++

extern DELPHI_PACKAGE unsigned __fastcall FormatBuf(void *Buffer, unsigned BufLen, const void *Format, unsigned FmtLen, const System::TVarRec *Args, const int Args_High)/* overload */;

プロパティ

種類 可視性 ソース ユニット 親
function public
System.AnsiStrings.pas
System.AnsiStrings.hpp
System.AnsiStrings System.AnsiStrings


説明

配列の引数を整形し、バッファ内にその結果を配置します。

この関数は、指定されたオープンな配列にある一連の引数を、テキスト バッファ内で整形します。

Buffer は、結果を受け取るテキスト バッファです。

BufLen は、Buffer 内のバイト数です。

Format は、引数をどのように整形するかを決定する、書式文字列です。 書式文字列の情報については、Format 文字列を参照してください。

FmtLen は、Format 内のバイト数です。

Args は、Format 内の書式指定子と置き換えられる、引数の配列です。

メモ:Args_Size は、Args の最後の要素のをインデックスです(実際の引数の数より 1 少ない数)。

FormatBuf は、結果文字列の長さを、バイト数で返します。

FormatBuf の第 1 の形式は、グローバル変数に含まれているローカライズ情報を使用するため、スレッド セーフではありません。 FormatBuf の第 2 の形式は、AFormatSettings パラメータに含まれているローカライズ情報を参照し、スレッド セーフです。 FormatBuf のスレッド セーフ形式を呼び出す前に、AFormatSettings にローカライズ情報を入れる必要があります。 AFormatSettings にデフォルトのローカル値セットを入れるには、TFormatSettings.Create を呼び出します。

関連項目