_vscprintf, _vscprintf_l, _vscwprintf, _vscwprintf_l

Article
12/18/2017

The latest version of this topic can be found at _vscprintf, _vscprintf_l, _vscwprintf, _vscwprintf_l.

Returns the number of characters in the formatted string using a pointer to a list of arguments.

Syntax

int _vscprintf(  
   const char *format,  
   va_list argptr   
);  
int _vscprintf_l(  
   const char *format,  
   locale_t locale,  
   va_list argptr   
);  
int _vscwprintf(  
   const wchar_t *format,  
   va_list argptr   
);  
int _vscwprintf_l(  
   const wchar_t *format,  
   locale_t locale,  
   va_list argptr   
);

Parameters

format
Format-control string.

argptr
Pointer to list of arguments.

locale
The locale to use.

For more information, see Format Specifications.

Return Value

_vscprintf returns the number of characters that would be generated if the string pointed to by the list of arguments was printed or sent to a file or buffer using the specified formatting codes. The value returned does not include the terminating null character. _vscwprintf performs the same function for wide characters.

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.

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

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.

Important

Ensure that if format is a user-defined string, it is null terminated and has the correct number and type of parameters. For more information, see Avoiding Buffer Overruns.

Generic-Text Routine Mappings

TCHAR.H routine	_UNICODE & _MBCS not defined	_MBCS defined	_UNICODE defined
`_vsctprintf`	`_vscprintf`	`_vscprintf`	`_vscwprintf`
`_vsctprintf_l`	`_vscprintf_l`	`_vscprintf_l`	`_vscwprintf_l`

Requirements

Routine	Required header
`_vscprintf`, `_vscprintf_l`	<stdio.h>
`_vscwprintf`, `_vscwprintf_l`	<stdio.h> or <wchar.h>

For additional compatibility information, see Compatibility in the Introduction.

Example

See the example for vsprintf.