StringCbPrintfW 함수(strsafe.h)

아티클
08/26/2023

서식이 지정된 데이터를 지정된 문자열에 씁니다. 대상 버퍼의 크기는 이 버퍼의 끝을 지나서 작성되지 않도록 함수에 제공됩니다.

StringCbPrintf 는 다음 함수를 대체합니다.

구문

STRSAFEAPI StringCbPrintfW(
  [out] STRSAFE_LPWSTR  pszDest,
  [in]  size_t          cbDest,
  [in]  STRSAFE_LPCWSTR pszFormat,
        ...             
);

매개 변수

[out] pszDest

형식: LPTSTR

pszFormat 및 해당 인수에서 만든 형식이 지정된 null로 끝나는 문자열을 수신하는 대상 버퍼입니다.

[in] cbDest

형식: size_t

대상 버퍼의 크기(바이트)입니다. 이 값은 최종 형식의 문자열과 종료 null 문자를 수용할 수 있을 정도로 충분히 커야 합니다. 허용되는 최대 바이트 수는 입니다 STRSAFE_MAX_CCH * sizeof(TCHAR).

[in] pszFormat

형식: LPCTSTR

서식 문자열입니다. 이 문자열은 null로 종료되어야 합니다. 자세한 내용은 형식 사양 구문을 참조하세요.

...

pszFormat 문자열에 삽입할 인수입니다.

반환 값

형식: HRESULT

이 함수는 다음 값 중 하나를 반환할 수 있습니다. SUCCEEDED 및 FAILED 매크로를 사용하여 이 함수의 반환 값을 테스트하는 것이 좋습니다.

반환 코드	Description
S_OK	잘림 없이 결과를 pszDest 에 복사할 수 있는 충분한 공간이 있었고 버퍼는 null로 종료됩니다.
STRSAFE_E_INVALID_PARAMETER	cbDest의 값은 0이거나 보다 `STRSAFE_MAX_CCH * sizeof(TCHAR)`큽니다.
STRSAFE_E_INSUFFICIENT_BUFFER	버퍼 공간이 부족하여 복사 작업이 실패했습니다. 대상 버퍼에는 의도한 결과의 잘린 null 종료 버전이 포함됩니다. 잘림이 허용되는 상황에서는 반드시 실패 조건으로 간주되지 않을 수 있습니다.

이 함수는 대체되는 함수와 달리 HRESULT 값을 반환합니다.

설명

StringCbPrintf는 대체되는 함수와 비교하여 코드에서 적절한 버퍼 처리를 위한 추가 처리를 제공합니다. 버퍼 처리 불량은 버퍼 오버런과 관련된 많은 보안 문제에 연루됩니다. StringCbPrintf 는 항상 null 길이가 아닌 대상 버퍼를 종료합니다.

pszDest, pszFormat 또는 인수 문자열이 가리키는 문자열이 겹치면 동작이 정의되지 않습니다.

pszFormat과 pszDest는 모두 NULL이 아니어야 합니다. null 문자열 포인터 값을 처리해야 하는 경우 StringCbPrintfEx 를 참조하세요.

StringCbPrintf 는 제네릭 형식 또는 보다 구체적인 형식으로 사용할 수 있습니다. 문자열의 데이터 형식은 사용해야 하는 이 함수의 형식을 결정합니다.

문자열 데이터 형식	문자열 리터럴	기능
char	"문자열"	StringCbPrintfA
TCHAR	TEXT("string")	StringCbPrintf
Wchar	L"string"	StringCbPrintfW

예제

다음 예제에서는 4개의 인수를 사용하여 StringCbPrintf를 기본적으로 사용하는 방법을 보여줍니다.

int const arraysize = 30;
TCHAR pszDest[arraysize]; 
size_t cbDest = arraysize * sizeof(TCHAR);

LPCTSTR pszFormat = TEXT("%s %d + %d = %d.");
TCHAR* pszTxt = TEXT("The answer is");

HRESULT hr = StringCbPrintf(pszDest, cbDest, pszFormat, pszTxt, 1, 2, 3);

// The resultant string at pszDest is "The answer is 1 + 2 = 3."

참고

strsafe.h 헤더는 STRINGCbPrintf를 유니코드 전처리기 상수의 정의에 따라 이 함수의 ANSI 또는 유니코드 버전을 자동으로 선택하는 별칭으로 정의합니다. 인코딩 중립 별칭을 인코딩 중립이 아닌 코드와 혼합하면 컴파일 또는 런타임 오류가 발생하는 불일치가 발생할 수 있습니다. 자세한 내용은 함수 프로토타입에 대한 규칙을 참조하세요.

요구 사항


지원되는 최소 클라이언트	WINDOWS XP SP2 [데스크톱 앱 \| UWP 앱]
지원되는 최소 서버	WINDOWS Server 2003 SP1 [데스크톱 앱 \| UWP 앱]
대상 플랫폼	Windows
헤더	strsafe.h