ppd_mark_option(3) a set of functions

Other Alias

ppd_check_option_is_marked, ppd_mark_defaults

SYNOPSIS

#include <ppd.h>

gboolean ppd_check_option_is_marked (PpdFile *ppd, const char *keyword, const char *option);

gint ppd_mark_option(PpdFile *ppd, const char *option, const char *choice);

void ppd_mark_defaults (PpdFile *ppd);

DESCRIPTION

These three functions are used to query the marked status of an option in a PPD file as well as forcing an option to be selected.

ppd_check_option_is_marked(PpdFile *ppd, const char *option, const char *choice);

ppd_check_option_is_marked() accepts three parameters as input. The first is the PpdFile pointer to a PPD file obtained by calling one of the ppd_load(3) functions. The second parameter is the option of the keyword name. The final input parameter is the actual choice name.

ppd_mark_option(PpdFile *ppd, const char *option, const char *choice);

ppd_mark_option allows the programmer to manually select an option in a PPD file. The parameters are the a valid PpdFile pointer (see ppd_file_new(3)), the option name, and the choice name.

void ppd_mark_defaults (PpdFile *ppd);

ppd_mark_defaults() resets all the default options in the PPD file specified by the PpdFile pointer (see ppd_file_new(3)).

RETURN VALUE

ppd_check_option_is_marked()
FALSE if the option is not currently selected and TRUE is it marked
ppd_mark_option()
Always returns 0. The only means of determining whether or not the function succeeded is to make a subsequent call to ppd_check_option_is_marked() on the same option.

AUTHOR

This man page was written by Gerald Carter <[email protected]>. It was updated by Mark Fasheh <[email protected]> to reflect changes in libppd 0.5. Some of the code was originally part of the Common UNIX Printing System (CUPS).