Функция StringCchPrintf

Функция StringCchPrintf - это замена функции sprintf. Она принимает форматирующую строку и список параметров и возвращает отформатированную строку. Размер, в символах, целевого буфера назначается в функцию для того, чтобы гарантировать, что StringCchPrintf не запишет помимо конца этого буфера.

Синтаксис

HRESULT StringCchPrintf(      

    LPTSTR pszDest,
    size_t cchDest,
    LPCTSTR pszFormat,
     ...
);

Параметры

pszDest

[out] Указатель на буфер, который получает отформатированную строку с завершающим нулем, созданную из pszFormat и его параметров.

cchDest

[in]Размер целевого буфера, в символах. Это значение должно быть достаточно большим, чтобы вместить конечную отформатированную строку плюс 1, чтобы принять во внимание символ завершающего нуля. Максимальное число символов допускается STRSAFE_MAX_CCH.

pszFormat

[in] Указатель на буфер, содержащий форматирующая строку printf-стиля. Эта строка должна быть завершена символом конца строки ('\0').

...

[in] Параметры, которые будут вставлены в pszFormat.

Возвращаемое значение

Обратите внимание! на то, что эта функция возвращает HRESULT в противоположность функции sprintf, которая возвращает число байтов, сохраненных в целевом буфере. Настоятельно рекомендуется использовать макроопределения SUCCEEDED и FAILED, чтобы проверить возвращаемое значение этой функцией.

Значение

Предназначение

S_OK Было достаточное место для результата копирования pszDest без усечения, а буфер завершен символом конца строки ('\0').
STRSAFE_E_INVALID_PARAMETER Значение в cchDest или 0 или больше, чем STRSAFE_MAX_CCH.
STRSAFE_E_INSUFFICIENT_BUFFER Операция копирования завершалась ошибкой из-за недостаточного места в буфере. Целевой буфер содержит обрезанную версию с нулевым символом в конце предполагаемого результата. В ситуациях, где усечение является приемлемым, это может не обязательно быть отмечено как условие сбоя.

Замечания

Функция StringCchPrintf предусматривает дополнительную обработку для правильной работы буфера в Вашем коде. Недостаточная обработка буфера влечет за собой многие проблемы обеспечения безопасности, которые вызывают переполнение буфера. StringCchPrintf всегда завершает символом конца строки ('\0') целевой буфер ненулевой длины.

Функция StringCchPrintf может быть использована в своей общей форме, или в спецальной, такой как StringCchPrintfA (для строк ANSI) или StringCchPrintfW (для строк Unicode). Форма использования определяется Вашими данными.

 

Тип строковых данных

Строковый литерал

Функция

char "string" StringCchPrintfA
TCHAR TEXT("string") StringCchPrintf
WCHAR L"string" StringCchPrintfW

Функция StringCchPrintf и её ANSI и Unicode варианты - заменяют эти функции:

 

Поведение не определяется, если строки указанные при помощи pszDest, pszFormat, или какими-либо параметрами строк перекрываются.

Ни  pszFormat, ни pszDest не должны быть NULL. Смотри описание StringCchPrintfEx, если вам требуется обработка значений указателя пустой строки.

Пример

Пример ниже показывает простое использование функции StringCchPrintf, которая применяет четыре параметра.

TCHAR pszDest[30];
size_t cchDest = 30;

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

HRESULT hr = StringCchPrintf(pszDest, cchDest, pszFormat, pszTxt, 1, 2, 3);

// Результирущая строка pszDest - "Ответом является 1 + 2 = 3."

Смотри также

Обзор Строки, Функции, используемые строкамиStringCbPrintf, StringCchPrintfEx, StringCchVPrintf

Размещение и совместимость StringCchPrintf

К Windows XP Да
л Windows 2000 Professional Да
и Windows NT Workstation Да версии 3.1
е Windows Me Да
н Windows 98 Да
т Windows 95 Да
 
С Windows Server 2003 Да
е Windows 2000 Server Да
р Windows NT Server Да версии 3.1
в    
е    
р    
Используемая библиотека strsafe.lib
Используемая DLL -
Заголовочный файл  
- объявлено в strsafe.h
- включено в -
Unicode Реализуются как версии Unicode и ANSI.
Замечания по платформе Не имеется

 

Назад в оглавление
На главную страницу
В оглавление справки

Hosted by uCoz