Informix-ESQL/C Programmer's Manual

Informix-ESQL/C Programmer's Manual
Introduction

Home Contents Index Master Index New Book

Documentation Conventions

This section describes the conventions that this manual uses. These conventions make it easier to gather information from this and other Informix manuals.

The following conventions are covered:

Typographical conventions
Icon conventions
Command-line conventions

Typographical Conventions

This manual uses the following standard set of conventions to introduce new terms, illustrate screen displays, describe command syntax, and so forth.


Convention	Meaning
`KEYWORD`	All keywords appear in uppercase letters in a serif font.
italics	Within text, new terms and emphasized words appear in italics. Within syntax diagrams, values that you are to specify appear in italics.
boldface	`I`dentifiers (names of classes, objects, constants, events, functions, program variables, forms, labels, and reports), environment variables, database names, filenames, table names, column names, icons, menu items, command names, and other similar terms appear in boldface.
`monospace`	Information that the product displays and information that you enter appear in a monospace typeface.
`KEYSTROKE`	Keys that you are to press appear in uppercase letters in a sans serif font.
	This symbol indicates the end of feature-, product-, platform-, or compliance-specific information.

Tip: When you are instructed to "enter" characters or to "execute" a command, immediately press RETURN after the entry. When you are instructed to "type" the text or to "press" other keys, no RETURN is required.

Icon Conventions

Throughout the documentation, you will find text that is identified by several different types of icons. This section describes these icons.

Comment Icons

Comment icons identify warnings, important notes, or tips. This information is always displayed in italics.


Icon	Description
	The warning icon identifies vital instructions, cautions, or critical information.
	The important icon identifies significant information about the feature or operation that is being described.
	The tip icon identifies additional details or shortcuts for the functionality that is being described.

Feature, Product, and Platform Icons

Feature, product, and platform icons identify paragraphs that contain feature-, product-, or platform-specific information.


Icon	Description
	Identifies information that is specific to a user-defined routine (`UDR`) that is written in an external language (such as C)
	Identifies information that is specific to the Informix Global Language Support (`GLS)` feature.
	Identifies information that is specific to `INFORMIX-U`niversal `S`erver.
	Identifies information that is specific to `INFORMIX-O`n`L`ine `D`ynamic `S`erver.
	Identifies information that is specific to `INFORMIX-O`nLine `W`orkgroup `S`erver.
	Identifies information that is specific to `INFORMIX-SE`.
	Identifies information that is specific to a user-defined routine (`UDR`) that is written in Informix Stored Procedure Language.
	Identifies information that is specific to the `UNIX` operating system.
	Identifies information that is specific to the Windows NT environment.
	Identifies information that is specific to the Windows 95 environment.
	Identifies information that is specific to both Windows NT and Windows 95 environments.
	Identifies information that is specific to `INFORMIX-O`nLine `XPS`.
	Identifies functionality that conforms to `X/O`pen specifications for dynamic `SQL`. This functionality is available when you compile your `SQL API` with the -xopen flag.

These icons can apply to a row in a table, one or more paragraphs, or an entire section. A symbol indicates the end of the feature-, product-, or platform-specific information.

Command-Line Conventions

This section defines and illustrates the format of commands that are available in Informix products. These commands have their own conventions, which might include alternative forms of a command, required and optional parts of the command, and so forth.

INFORMIX-ESQL/C supports a variety of command-line options. Each valid command-line option is illustrated in a diagram in Chapter 1, "Programming with INFORMIX-ESQL/C."

Each diagram displays the sequences of required and optional elements that are valid in a command. A diagram begins at the upper-left corner with a command. It ends at the upper-right corner with a vertical line. Between these points, you can trace any path that does not stop or back up. Each path describes a valid form of the command. You must supply a value for words that are in italics.

You might encounter one or more of the following elements on a command-line path.

(1 of 2)

Element Description
command

This required element is usually the product name or other short word that invokes the product or calls the compiler or preprocessor script for a compiled Informix product. It might appear alone or precede one or more options. You must spell a command exactly as shown and use lowercase letters.

variable

A word in italics represents a value that you must supply, such as a database, file, or program name. A table following the diagram explains the value.

-flag

A flag is usually an abbreviation for a function, menu, or option name or for a compiler or preprocessor argument. You must enter a flag exactly as shown, including the preceding hyphen.

.ext

A filename extension, such as .sql or .cob, might follow a variable that represents a filename. Type this extension exactly as shown, immediately after the name of the file. The extension might be optional in certain products.

( . , ; + * - / )

Punctuation and mathematical notations are literal symbols that you must enter exactly as shown.

' '

Single quotes are literal symbols that you must enter as shown.

A reference in a box represents a subdiagram. Imagine that the subdiagram is spliced into the main diagram at this point. When a page number is not specified, the subdiagram appears on the same page.

A shaded option is the default action.

Syntax within a pair of arrows indicates a subdiagram.

The vertical line terminates the command.

A branch below the main path indicates an optional path. (Any term on the main path is required, unless a branch can circumvent it.)

A loop indicates a path that you can repeat. Punctuation along the top of the loop indicates the separator symbol for list items.

A gate (
) on a path indicates that you can only use that path the indicated number of times, even if it is part of a larger loop. Here you can specify size no more than three times within this statement segment.

How to Read a Command-Line Diagram

Figure 1 shows a command-line diagram that uses some of the elements that are listed in the previous table.


Figure 1 Example of a Command-Line Diagram

To construct a command correctly, start at the top left with the command. Then follow the diagram to the right, including the elements that you want. The elements in the diagram are case sensitive.

Figure 1 diagrams the following steps:

1. Type the word setenv.

2. Type the word INFORMIXC.

3. Supply either a compiler name or pathname.

4. Press RETURN to execute the command.

Informix-ESQL/C Programmer's Manual, version 9.1
Copyright © 1998, Informix Software, Inc. All rights reserved.