Share via


_scprintf_p, _scprintf_p_l, _scwprintf_p, _scwprintf_p_l

Returns the number of characters in the formatted string, with the ability to specify the order in which parameters are used in the format string.

int _scprintf_p(
   const char *format [,
   argument] ... 
);
int _scprintf_p_l(
   const char *format,
   locale_t locale [,
   argument] ... 
);
int _scwprintf_p (
   const wchar_t *format [,
   argument] ... 
);
int _scwprintf_p _l(
   const wchar_t *format,
   locale_t locale [,
   argument] ... 
);

Parameters

  • format
    Format-control string.

  • argument
    Optional arguments.

  • locale
    The locale to use.

Return Value

Returns the number of characters that would be generated if the string were to be printed or sent to a file or buffer using the specified formatting codes. The value returned does not include the terminating null character. _scwprintf_p performs the same function for wide characters.

The difference between _scprintf_p and _scprintf is that _scprintf_p supports positional parameters, which allows specifying the order in which the arguments are used in the format string. For more information, see printf_p Positional Parameters.

If format is a NULL pointer, the invalid parameter handler is invoked, as described in Parameter Validation. If execution is allowed to continue, these functions return -1 and set errno to EINVAL.

For information about these and other error codes, see _doserrno, errno, _sys_errlist, and _sys_nerr.

Remarks

Each argument (if any) is converted according to the corresponding format specification in format. The format consists of ordinary characters and has the same form and function as the format argument for printf.

The versions of these functions with the _l suffix are identical except that they use the locale parameter passed in instead of the current thread locale.

Security noteSecurity Note

Ensure that format is not a user-defined string.

Generic-Text Routine Mappings

Tchar.h routine

_UNICODE and _MBCS not defined

_MBCS defined

_UNICODE defined

_sctprintf_p

_scprintf_p

_scprintf_p

_scwprintf_p

_sctprintf_p_l

_scprintf_p_l

_scprintf_p_l

_scwprintf_p_l

Requirements

Routine

Required header

_scprintf_p, _scprintf_p_l

<stdio.h>

_scwprintf_p, _scwprintf_p_l

<stdio.h> or <wchar.h>

For more compatibility information, see Compatibility in the Introduction.

See Also

Reference

Stream I/O

_scprintf, _scprintf_l, _scwprintf, _scwprintf_l

_printf_p, _printf_p_l, _wprintf_p, _wprintf_p_l