Microsoft MVP성태의 닷넷 이야기
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일
 

어떤 것을 쓰면 좋을까요? ^^ wvnsprintf, _vsnwprintf_s, StringCbVPrintfW

물론 상황에 따라 다르겠지요. ^^

일단 wvnsprintf를 사용하는 예제 먼저 볼까요?

void OutputText(const wchar_t *format, ...)
{
    wchar_t buffer[10];

    va_list vaList;
    va_start(vaList, format);
    int retval = wvnsprintf(buffer, 10, format, vaList); // retval == -1
    va_end(vaList);

    printf("%S\n", buffer);
}

int _tmain(int argc, _TCHAR* argv[])
{
    OutputText1(L"%d12345678901234567890", 0); // 출력결과: 012345678
    return 0;
}

위의 경우 OutputText 함수 내에 10개의 버퍼(wchar_t이므로 20바이트)를 마련했지만 인자로 들어온 값들이 이를 넘어서는 경우 반환값이 -1로 나옵니다.

wvnsprintf function
; https://docs.microsoft.com/en-us/windows/win32/api/shlwapi/nf-shlwapi-wvnsprintfa

하지만 문서에는 이에 대한 사용을 하지 말라고 나옵니다.

Do not use this function. See Remarks for alternative functions.

Security Warning: Using this function incorrectly can compromise the security of your application. The copied string is not guaranteed to be null-terminated. Consider using one of the following alternatives. StringCbPrintf, StringCbPrintfEx, StringCbVPrintf, StringCbVPrintfEx, StringCchPrintf, StringCchPrintfEx, StringCchVPrintf, or StringCchVPrintfEx. You should review Security Considerations: Microsoft Windows Shell before continuing.


근데 테스트해 보면 버퍼가 적어도 마지막을 '\0' 널 문자로 채워주었습니다. 아마도 예전 버전에서 그랬던 것인지, 아니면 특정 상황에서 그럴 수 있는지는 알 수 없으나 어쨌든 경고 문구가 있으니 달갑지는 않습니다. ^^

여기서 결론을 내면 좀 아쉽지만 결국 답은 StringCbVPrintfW를 사용하는 것이 좋습니다.

#include <Strsafe.h>

void OutputText3(const wchar_t *format, ...)
{
    wchar_t buffer[10];

    va_list vaList;
    va_start(vaList, format);
    int retval = StringCbVPrintfW(buffer, sizeof(wchar_t) * 10, format, vaList); // retval == -2147024774
    va_end(vaList);

    printf("%S", buffer);
}

OutputText3(L"%d12345678901234567890", 0);

StringCbVPrintfW가 wvnsprintf와 다른 점이 있다면 버퍼가 모자른 경우 반환값이 -1이 아니라 0x8007007A(-2147024774: The data area passed to a system call is too small.)로 나오는 점입니다.

그리고 버퍼 카운트가 wchar_t라고 해서 그 배열의 수를 그대로 전달하면 안되고 순수하게 byte 수를 전달해야 한다는 점입니다. 따라서 wvnsprintf는 버퍼 수를 10으로 줘도 되었지만 StringCbVPrintfW는 10 * sizeof(wchar_t)로 해야 합니다.

이제, 마지막으로 _vsnwprintf_s가 있는데... 이건 사용시 주의를 요합니다. wvnsprintf와는 달리 string safe 버전이기 때문에 대상 버퍼에 대한 관리가 특별합니다.

wchar_t buffer[10];

va_list vaList;
va_start(vaList, format);
int retval = _vsnwprintf_s(buffer, 10, format, vaList);
va_end(vaList);

단순히 사용하게 되면 버퍼가 모자르는 상황에 대해 디버그 빌드일 때는 예외 발생, 릴리스 빌드일 때는 프로그램 비정상 종료로 이어집니다.

output_format_text_1.png

Debug Assertioin failed!

Program:
...
File: f:\dd\vctools\crt\crtw32\stdio\vswprint.c
Line: 358

Expression: ("Buffer too small", 0)

For information on how your program can cause an assertion failure, see the Visual C++ documentation on asserts.

(Press Retry to debug the applicaiton)

그래서 아무 생각 없이 안전한 환경에서 사용하다가 릴리스 후 예측할 수 없는 클라이언트 환경에서 뜻하지 않은 오동작을 만날 수 있습니다.

다행히 _vsnwprintf_s는 wvnsprintf처럼 동작하는 방식도 지원합니다. 이를 위해 버퍼 수를 _TRUNCATE 전처리 상수로 지정하면 됩니다. (_TRUNCATE는 crtdefs.h파일에 -1로 정의되어 있습니다.)

wchar_t buffer[10];

va_list vaList;
va_start(vaList, format);
int retval = _vsnwprintf_s(buffer, _TRUNCATE, format, vaList);
va_end(vaList);

위의 코드는 wvnsprintf와 동작 방식이 같습니다.




정리해 보면 _vsnwprintf_s와 StringCbVPrintfW 함수를 사용하는 것이 권장됩니다.

대신 _vsnwprintf_s의 경우 예외 발생으로 인해 주의를 요하는데 디버그 시에는 확실히 문제를 인지할 수 있도록 버퍼를 지정하는 것이 좋고, 릴리스 시에는 _TRUNCATE로 처리하는 것이 좋습니다.




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[연관 글]


donaricano-btn



[최초 등록일: ]
[최종 수정일: 7/17/2021]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 쓴 사람
 



2014-03-18 07시10분
본문의 StringCbVPrintfW는 "W"이면서도 "byte"를 취급하는 것이 이상한데요. 대신 StringCchVPrintfW를 쓰는 것이 더 나을 것 같습니다. ^^
정성태
2014-08-14 04시52분
안전함수(_s)에서 예외 창이 뜨는 것을 제어하려면 핸들러를 설치하면 됩니다.

_set_invalid_parameter_handler
; http://msdn.microsoft.com/ko-kr/library/a9yf33zb.aspx
정성태
2021-10-13 10시12분
[조용환] StringCbVPrintfW(buffer, sizeof(buffer), ...); 으로 하면 됩니다.
StringCCh 와 StringCb 중에 어떤게 쓰기 편할지 고민하는 중인데 Cb는 위와같이 배열을 썻을 경우 sizeof로 코드가 깔끔하게 떨어지는 측면이 있어서 좋네요
[손님]
2021-10-13 10시13분
[조용환] 약어를 추측해보건대 Cb 는 count byte 이고, Cch는 count char 으로 추측되고, 각각 바이트수, 글자수 가 될거 같네요
[손님]

[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
12868정성태12/7/202116오류 유형: 770. twine 업로드 시 "HTTPError: 400 Bad Request ..." 오류
12867정성태12/7/202128개발 환경 구성: 612. 파이썬 - PyPI 패키지 만들기 (3) entry_points 옵션
12866정성태12/7/202115오류 유형: 769. "docker build ..." 시 "failed to solve with frontend dockerfile.v0: failed to read dockerfile ..." 오류
12865정성태12/6/202129개발 환경 구성: 611. 파이썬 - PyPI 패키지 만들기 (2) long_description, cmdclass 옵션
12864정성태12/6/202140Linux: 46. WSL 환경에서 find 명령을 사용해 파일을 찾는 방법
12863정성태12/4/202151개발 환경 구성: 610. 파이썬 - PyPI 패키지 만들기
12862정성태12/3/202146오류 유형: 768. Golang - 빌드 시 "cmd/go: unsupported GOOS/GOARCH pair linux /amd64" 오류
12861정성태12/3/202162개발 환경 구성: 609. 파이썬 - "Windows embeddable package"로 개발 환경 구성하는 방법
12860정성태12/1/2021119오류 유형: 767. SQL Server - 127.0.0.1로 접속하는 경우 "Access is denied"가 발생한다면?
12859정성태12/1/2021134개발 환경 구성: 608. Hyper-V 가상 머신에 Console 모드로 로그인하는 방법
12858정성태11/30/2021318개발 환경 구성: 607. 로컬의 USB 장치를 원격 머신에 제공하는 방법 - usbip-win
12857정성태11/24/2021112개발 환경 구성: 606. WSL Ubuntu 20.04에서 파이썬을 위한 uwsgi 설치 방법
12856정성태11/23/2021334.NET Framework: 1121. C# - 동일한 IP:Port로 바인딩 가능한 서버 소켓 [2]
12855정성태11/13/2021111개발 환경 구성: 605. Azure App Service - Kudu SSH 환경에서 FTP를 이용한 파일 전송
12854정성태11/13/2021230개발 환경 구성: 604. Azure - 윈도우 VM에서 FTP 여는 방법
12853정성태11/10/2021137오류 유형: 766. Azure App Service - JBoss 호스팅 생성 시 "This region has quota of 0 PremiumV3 instances for your subscription. Try selecting different region or SKU."
12851정성태11/1/2021236스크립트: 34. 파이썬 - MySQLdb 기본 예제 코드
12850정성태10/27/2021514오류 유형: 765. 우분투에서 pip install mysqlclient 실행 시 "OSError: mysql_config not found" 오류
12849정성태10/17/2021517스크립트: 33. JavaScript와 C#의 시간 변환
12848정성태10/17/2021475스크립트: 32. 파이썬 - sqlite3 기본 예제 코드
12847정성태10/14/2021428스크립트: 31. 파이썬 gunicorn - WORKER TIMEOUT 오류 발생
12846정성태10/7/2021524스크립트: 30. 파이썬 __debug__ 플래그 변수에 따른 코드 실행 제어
12845정성태10/6/2021892.NET Framework: 1120. C# - BufferBlock<T> 사용 예제 [4]파일 다운로드1
12844정성태10/3/2021445오류 유형: 764. MSI 설치 시 "... is accessible and not read-only." 오류 메시지
12843정성태10/3/2021489스크립트: 29. 파이썬 - fork 시 기존 클라이언트 소켓 및 스레드의 동작파일 다운로드1
[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...