Export (0) Print
Expand All
div
eof
Expand Minimize

_vsprintf_p, _vsprintf_p_l, _vswprintf_p, _vswprintf_p_l 

Write formatted output using a pointer to a list of arguments, with the ability to specify the order in which the arguments are used.


int _vsprintf_p(
   char *buffer,
   size_t numberOfElements,
   const char *format,
   va_list argptr 
); 
int _vsprintf_p_l(
   char *buffer,
   size_t numberOfElements,
   const char *format,
   locale_t locale,
   va_list argptr 
); 
int _vswprintf_p(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format,
   va_list argptr 
);
int _vswprintf_p_l(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format,
   locale_t locale,
   va_list argptr 
);

Parameters

buffer

Storage location for output.

numberOfElements

Size of buffer in characters.

count

Maximum number of characters to store, in the UNICODE version of this function.

format

Format specification.

argptr

Pointer to list of arguments.

locale

The locale to use.

_vsprintf_p and _vswprintf_p return the number of characters written, not including the terminating null character, or a negative value if an output error occurs.

Each of these functions takes a pointer to an argument list, and then formats and writes the given data to the memory pointed to by buffer.

These functions differ from the vsprintf_s and vswprintf_s only in that they support positional parameters. For more information, see printf_p Positional Parameters.

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 the buffer or format parameters are NULL pointers, if count is zero, or if the format string contains invalid formatting characters, 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.

Generic-Text Routine Mappings
TCHAR.H routine _UNICODE & _MBCS not defined _MBCS defined _UNICODE defined

_vstprintf_p

_vsprintf_p

_vsprintf_p

_vswprintf_p

_vstprintf_p_l

_vsprintf_p_l

_vsprintf_p_l

_vswprintf_p_l

Routine Required header Optional headers Compatibility

_vsprintf_p, _vsprintf_p_l

<stdio.h> and <stdarg.h>

<varargs.h>*

Windows 95, Windows 98, Windows 98 Second Edition, Windows Millennium Edition, Windows NT 4.0, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003

_vswprintf_p, _vswprintf_p_l

<stdio.h> or <wchar.h>, and <stdarg.h>

<varargs.h>*

Windows 95, Windows 98, Windows 98 Second Edition, Windows Millennium Edition, Windows NT 4.0, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003

* Required for UNIX V compatibility.

For additional compatibility information, see Compatibility in the Introduction.

// crt__vsprintf_p.c
// This program uses vsprintf_p to write to a buffer.
// The size of the buffer is determined by _vscprintf_p.

#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>


void example( char * format, ... )
{
    va_list  args;
    int      len;
    char     *buffer = NULL;

    va_start( args, format );

    // _vscprintf doesn't count the 
    // null terminating string so we add 1.
    len = _vscprintf_p( format, args ) + 1;

    // Allocate memory for our buffer
    buffer = (char*)malloc( len * sizeof(char) );
    if (buffer)
    {
        _vsprintf_p( buffer, len, format, args );
        puts( buffer );
        free( buffer );
    }
}


int main( void )
{
    // First example
    example( "%2$d %1$c %3$d", '<', 123, 456 );

    // Second example
    example( "%s", "This is a string" );
}

Output

123 < 456
This is a string

Community Additions

ADD
Show:
© 2014 Microsoft