# Synopsis

PDX_MSGT ugn_PrintUsage(long option, UGN_OPTS *opts, char *prog_name, char *extra_args, char *desc[])

# Purpose

Displays a usage message

# Description

A usage message showing the syntax of the command based on the opts structure will be printed to stderr. See the manual page for ugn_ParseCommandLine for a description of the opts structure. The val_name field in the opts structure is used as a place holder to indicate the value portion of each option. The extra_args field can be used to show non-option input (such as file names) to the command. The desc field contains an array of character strings which are printed after the usage statement. The last element of the desc array must be NULL. If no additional information is to be printed with the usage statement, a NULL may be passed for desc.

# Input

## option

Options (not used)

## opts

Options specification structure (see the ugn_ParseCommandLine manual page)

## prog_name

Name of program (usually just argv[0]). If a directory is included in the name, only the portion following the last directory character will be printed.

## extra_args

Additional arguments to display after options or NULL

## desc

Array of additional strings to be printed, last element must be NULL.

# Return

          Low level error return
          .fi