vprintf

http://www.cworldlab.com/CandCplus/clibrary/vsprintf.htm
vsprintf

---

기능	포맷된 출력을 문자열에 기록한다.
문법	#include <stdarg.h> int vsprintf(char *buffer, const chat *format va_list arglist);
DOS UNIX Windows ANSI C C++ only ■ ■ ■
주석	UNIX System V에서 사용 가능하다. v...printf함수는 ...printf함수를 위한 대치 입력점으로 알려져 있다. 이 함수는 ...printf 상대역과 똑같은 행동을 하지만 인수 목록 대신 인수의 목록 포인터를 받아들인다. vsprintf는 일련의 인수를 받아들이고 각 인수에 format이 가리키는 포맷문자열에 들어있는 포맷 명시자를 공급한 뒤 포맷된 데이터를 문자열에 출력한다.  이때 인수와 같은 수의 포맷 명시자가 있어야 한다.(포맷 명시자에 대한 자세한 설명은 printf를 참조하라).
반환값	vsprintf는 출력된 바이트 수를 반환하며 에러가 발생하며 ,EOF를 반환한다.
참조	printf,va_arg,va_end,va_start
예제	#include <stdio.h> #include <conio.h> #include <stdarg.h> char buffer[80]; int vspf(char *fmt, ...) {    va_list argptr;    int cnt;    va_start(argptr, fmt);    cnt = vsprintf(buffer, fmt, argptr);    va_end(argptr);    return(cnt); } int main(void) {    int inumber = 30;    float fnumber = 90.0;    char string[4] = "abc";    vspf("%d %f %s", inumber, fnumber, string);    printf("%s\n", buffer);    return 0; }

======================================================

 

vsprintf

function

int vsprintf (char * str, const char * format, va_list arg );

<cstdio>

Print formatted variable argument list to string

Writes into the array pointer by str a C string consisting in format with its format tags expanded to the values of the argument list arg formatted appropiately.
This function behaves exactly as sprintf except that the variable argument list is passed as a va_list instead of a succession of arguments, which becomes specially useful when the argument list to be passed comes itself from a variable argument list in the calling function.
vsprintf does not call the va_end macro.

Parameters

str

Array of char elements where the resulting string is to be stored.

format

C string that contains the text to be written to the str.
It can optionally contain embedded format tags that are substituted by the values specified in the arg variable argument list and formatted as requested.
The format tags follow this prototype:

%[flags][width][.precision][length]specifier
Where specifier is the most significant one and defines the type and the interpretation of the value of the coresponding argument:

specifier	Output	Example
c	Character	a
d or i	Signed decimal integer	392
e	Scientific notation (mantise/exponent) using e character	3.9265e+2
E	Scientific notation (mantise/exponent) using E character	3.9265E+2
f	Decimal floating point	392.65
g	Use the shorter of %e or %f	392.65
G	Use the shorter of %E or %f	392.65
o	Signed octal	610
s	String of characters	sample
u	Unsigned decimal integer	7235
x	Unsigned hexadecimal integer	7fa
X	Unsigned hexadecimal integer (capital letters)	7FA
p	Pointer address	B800:0000
n	Nothing printed. The argument must be a pointer to a signed int, where the number of characters written so far is stored.
%	A % followed by another % character will write a % sign.

The tag can also contain flags, width, .precision and modifiers sub-specifiers, which are optional and follow these specifications:

flags	description
-	Left-justify within the given field width; Right justification is the default (see width sub-specifier).
+	Forces to preceed the result with a plus or minus sign (+ or -) even for positive numbers. By default, only negative numbers are preceded with a - sign.
(space)	If no sign is going to be written, a blank space is inserted before the value.
#	Used with o, x or X specifiers the value is preceeded with 0, 0x or 0X respectively for values different than zero. Used with e, E and f, it forces the written output to contain a decimal point even if no digits would follow. By default, if no digits follow, no decimal point is written. Used with g or G the result is the same as with e or E but trailing zeros are not removed.
0	Left-pads the number with zeroes (0) instead of spaces, where padding is specified (see width sub-specifier).

width	description
(number)	Minimum number of characters to be printed. If the value to be printed is shorter than this number, the result is padded with blank spaces. The value is not truncated even if the result is larger.
*	The width is not specified in the format string, but as an additional integer value argument preceding the argument that has to be formatted.

.precision	description
.number	For integer specifiers (d, i, o, u, x, X): precision specifies the minimum number of digits to be written. If the value to be written is shorter than this number, the result is padded with leading zeros. The value is not truncated even if the result is longer. A precision of 0 means that no character is written for the value 0. For e, E and f specifiers: this is the number of digits to be printed after de decimal point. For g and G specifiers: This is the maximum number of significant digits to be printed. For s: this is the maximum number of characters to be printed. By default all characters are printed until the ending null character is encountered. For c type: it has no effect. When no precision is specified, the default is 1. If the period is specified without an explicit value for precision, 0 is assumed.
.*	The precision is not specified in the format string, but as an additional integer value argument preceding the argument that has to be formatted.

length	description
h	The argument is interpreted as a short int or unsigned short int (only applies to integer specifiers: i, d, o, u, x and X).
l	The argument is interpreted as a long int or unsigned long int for integer specifiers (i, d, o, u, x and X), and as a wide character or wide character string for specifiers c and s.
L	The argument is interpreted as a long double (only applies to floating point specifiers: e, E, f, g and G).

arg

An object representing the variable arguments list. It shall have already been initialized by the va_start macro defined in <cstdarg>.

Return Value

On success, the total number of characters written is returned.
On failure, a negative number is returned.

Example

/* vsprintf example */ #include <stdio.h> #include <stdarg.h> void PrintFError (char * format, ...) { char buffer[256]; va_list args; va_start (args, format); vsprintf (buffer,format, args); perror (buffer); va_end (args); } int main () { FILE * pFile; char szFileName[]="myfile.txt"; int firstchar = (int) '#'; pFile = fopen (szFileName,"r"); if (pFile == NULL) PrintFError ("Error opening '%s'",szFileName); else { // file successfully open fclose (pFile); } return 0; }

In this example, if the file myfile.txt does not exist, perror is called to show an error message similar to:

Error opening file 'myfile.txt': No such file or directory

 

http://www.winapi.co.kr/clec/cpp2/15-3-4.htm
15-3-라.가변 인수 함수의 활용

가변 인수 함수는 한 번 호출로 여러 개의 정보를 다양한 방법으로 다룰 수 있다는 면에서 편리하다. 특히 printf 함수는 다양한 타입의 변수들을 한꺼번에 출력할 수 있어 변수값을 확인해 볼 때 아주 유용하다. 이런 함수를 직접 만들려면 독자적으로 서식을 정의하고 서식 문자열과 대응되는 가변 인수를 직접 읽는 복잡한 루틴을 만들어야 하는데 다행히 이런 일을 대신해 주는 함수들을 준비되어 있다. 대표적으로 다음 두 함수만 소개 한다.

 int vprintf( const char *format, va_list argptr );

int vsprintf( char *buffer, const char *format, va_list argptr );

 이외에 vscanf, vsscanf 등의 함수도 있는데 알파벳 v(Variable)로 시작한다고 해서 이런 함수들을 v계열의 함수라고 한다. 위 두 함수들은 printf, sprintf와 동일한 기능을 수행하는데 가변 인수를 직접 나열하는 대신 가변 인수가 시작되는 번지만을 인수로 취한다는 점이 다르다. 즉 실제로 가변 인수를 취하지는 않으며 가변 인수를 취하는 다른 함수의 내부에서 printf 의 서식을 해석하고 적용하는 일을 대신한다.

이 두 함수를 사용하면 printf처럼 동작하는 비슷한 함수를 직접 만들어 쓸 수 있다. 다음 함수는 C/C++언어의 가변 인수 기능을 활용하여 실행중에 변수값을 디버거로 실시간 확인해 보는 기능을 제공한다.

 void CustomTrace(char *format, ...)

{

     char buf[1024];

     va_list marker;

    

     va_start( marker, format );

     vsprintf(buf,format,marker);

     OutputDebugString(buf);

}

 OutputDebugString이라는 API 함수가 사용되었는데 이 함수는 주어진 문자열을 디버깅 창으로 출력한다. 비주얼 C++의 경우 Output 윈도우에 이 함수의 출력 내용이 나타나므로 실행중에 변수값의 변화를 확인하거나 특정 함수의 호출 시점, 회수 등을 알고 싶을 때 중간 중간에 이 함수를 삽입해 놓으면 된다. 사용예를 들자면 다음과 같다.

 CustomTrace("변수 a=%d, 변수 f=%f\n",a,f);

CustomTrace("함수 func가 %d번째 호출되었음",count++);

 테트리스 예제의 다음 위치에 CustomTrace 함수 호출을 삽입해 놓으면 벽돌이 한칸씩 움직일 때마다 주요 전역변수값을 확인할 수 있다.

 for (;2;) {

     CustomTrace("벽돌=%d,회전=%d,위치=(%d,%d)\n",brick,rot,nx,ny);

 CustomTrace 함수의 내부는 무척 간단하다. va_start로 첫 번째 가변 인수의 번지를 구한 후 그 번지를 서식 문자열과 함께 vsprintf 함수로 넘기기만 하면 된다. OutputDebugString 함수를 직접 사용할 수 있지만 이 함수는 단순한 문자열만 출력할 수 있는데 비해 CustomTrace는 서식화된 문자열을 출력할 수 있어 훨씬 더 편리하다.

다음은 똑같은 목적의 좀 더 복잡한 함수를 소개한다. 이 함수는 Win32 파일 입출력 함수까지 사용하고 있기 때문에 현재 단계에서 분석해 보기는 어려우므로 차후에 API를 배운 후에 직접 분석해 보기 바란다.

 #define DEBUGLOGFILE "c:\\DebugLog.txt"

void WriteLogFile(char *strLog,...)

{

     HANDLE hLog;

     static int count=0;

     DWORD dwWritten;

     char szLog[1024];

     char strLog2[1024];

     va_list marker;

     SYSTEMTIME st;

 

     // 가변 인수를 조립한다.

     va_start( marker, strLog );

     vsprintf(szLog,strLog,marker);

      // 처음 호출될 때 파일을 만들고 이후부터는 파일을 열기만 한다.

     if (count == 0) {

          hLog=CreateFile(DEBUGLOGFILE,GENERIC_WRITE,0,NULL,

          CREATE_ALWAYS,FILE_ATTRIBUTE_NORMAL,NULL);

     } else {

          hLog=CreateFile(DEBUGLOGFILE,GENERIC_WRITE,0,NULL,

          OPEN_ALWAYS,FILE_ATTRIBUTE_NORMAL,NULL);

     }

      // 로그에 현재 시간과 카운터를 기록한다.

     GetLocalTime(&st);

     wsprintf(strLog2,"카운터=%06d(%d:%d:%d:%d) %s\r\n",count++,

          st.wHour,st.wMinute,st.wSecond,st.wMilliseconds,szLog);

     SetFilePointer(hLog,0,NULL,FILE_END);

     WriteFile(hLog,strLog2,strlen(strLog2),&dwWritten,NULL);

     CloseHandle(hLog);

}

 사용하는 방법은 printf나 CustomTrace와 동일하다. 단, 차이점이라면 조립된 서식 문자열이 화면이나 디버깅 창으로 출력되는 것이 아니라 지정한 파일에 기록된다는 것과 카운트, 호출 시점의 시간 등을 같이 기록한다는 점이다. 멀티 스레드 환경이나 실시간으로 동작하는 프로그램을 디버깅할 때는 디버거를 쓰기 쉽지 않기 때문에 모든 디버깅 정보를 파일에 일단 기록한 후 파일에 남겨진 로그(log) 정보를 분석하는 것이 더 효율적이다.

이럴 때 이 함수가 아주 유용하게 사용되며 실전에서 여러 번 활용했었는데 효과가 아주 좋았다. 릴리즈 모드에서만 증상이 나타날 때라든가 디버거를 쓸 수 없는 서비스류의 프로그램을 디버깅할 때 최후의 디버깅 방법으로 특히 많은 활약을 한다. 물론 이 함수도 더 개선해 볼 여지가 많은데 다음에 실력이 늘면 직접 개선해 보기 바란다.