[ prev :: next :: up ] libggi-current (3)

Parse and print formatted strings specifying modes

Name

ggiParseMode, ggiPrintMode, ggiSPrintMode, ggiFPrintMode : Parse and print formatted strings specifying modes

Synopsis

#include <ggi/ggi.h>


int ggiParseMode(const char *s, ggi_mode *m);

#define ggiPrintMode(m) ggiFPrintMode(stdout,(m))

int ggiSPrintMode(char *s, ggi_mode *m);
int ggiFPrintMode(FILE *s, ggi_mode *m);

Description

ggiParseMode parses a string into a ggi_mode.

The ggi*PrintMode functions print all the members of ggi_mode in a human-readable form. ggiSPrintMode outputs to a preallocated string buffer, ggiFPrintMode outputs to a stdio FILE, and ggiPrintMode outputs to standard output. These functions correspond to :man:`sprintf(3)`, :man:`fprintf(3)` and :man:`printf(3)` respectively.

System Message: ERROR/3 (../ggi-core/libggi/doc/libggi.txt, line 463); backlink

Unknown interpreted text role "man".

System Message: ERROR/3 (../ggi-core/libggi/doc/libggi.txt, line 463); backlink

Unknown interpreted text role "man".

System Message: ERROR/3 (../ggi-core/libggi/doc/libggi.txt, line 463); backlink

Unknown interpreted text role "man".

The format of the string used by these functions is exactly the same as the one used in the GGI_DEFMODE environment variable decribed in :man:`libggi(7)`.

System Message: ERROR/3 (../ggi-core/libggi/doc/libggi.txt, line 471); backlink

Unknown interpreted text role "man".

Return value

ggiParseMode returns:

0
on success, i.e. the string was correct. However, errors involving GT_*, position information, or mismatched brackets do not make it fail; these errors are simply ignored.
<0

if there is text that can not be parsed. This text is printed to stderr. All parameters parsed so far are written into :p:`m`.

System Message: ERROR/3 (../ggi-core/libggi/doc/libggi.txt, line 489); backlink

Unknown interpreted text role "p".

So :p:`m` contains all parameters that have been successfully parsed. For most applications there will be no need for testing ggiParseMode for failure.

System Message: ERROR/3 (../ggi-core/libggi/doc/libggi.txt, line 494); backlink

Unknown interpreted text role "p".
 
[ prev :: next :: up ] libggi-current (3)
2008/05/04 23:15:03