wcsprintf.h File Reference

Go to the source code of this file.

Functions

int wcsprintf_set (FILE *wcsout)
 Set output disposition for wcsprintf().
int wcsprintf (const char *format,...)
 Print function used by WCSLIB diagnostic routines.
const char * wcsprintf_buf (void)
 Get the address of the internal string buffer.


Detailed Description

These routines allow diagnostic output from celprt(), linprt(), prjprt(), spcprt(), tabprt(), and wcsprt() to be redirected to a file or captured in a string buffer. These routines use wcsprintf() for output.

Function Documentation

int wcsprintf_set ( FILE *  wcsout  ) 

wcsprintf_set() sets the output disposition for wcsprintf() which is used by the celprt(), linprt(), prjprt(), spcprt(), tabprt(), and wcsprt() routines.

Parameters:
[in] wcsout Pointer to an output stream that has been opened for writing, e.g. by the fopen() stdio library function, or one of the predefined stdio output streams - stdout and stderr. If zero (NULL), output is written to an internally-allocated string buffer, the address of which may be obtained by wcsprintf_buf().
Returns:
Status return value:
  • 0: Success.

int wcsprintf ( const char *  format,
  ... 
)

wcsprintf() is used by the celprt(), linprt(), prjprt(), spcprt(), tabprt(), and wcsprt() routines. Its output may be redirected to a file or string buffer via wcsprintf_set().

Parameters:
[in] format Format string, passed to one of the printf(3) family of stdio library functions.
[in] ... Argument list matching format, as per printf(3).
Returns:
Number of bytes written.

wcsprintf_buf ( void   ) 

wcsprintf_buf() returns the address of the internal string buffer created when wcsprintf_set() is invoked with its FILE* argument set to zero.

Returns:
Address of the internal string buffer. The user may free this buffer by calling wcsprintf_set() with a valid FILE*, e.g. stdout. The free() stdlib library function must NOT be invoked on this const pointer.


Generated on Mon Feb 7 18:03:57 2011 for WCSLIB 4.7 by  doxygen 1.5.6