PeopleCode Developer's Guide Preface

This preface includes typographical conventions used in PeopleCode and discusses the uses of this book.

Click to jump to top of pageClick to jump to parent topicPeopleCode Developer's Guide

This PeopleBook covers the concepts of PeopleCode, the programming language used in the development of PeopleSoft applications. Its chapters describe techniques for adding PeopleCode to applications, tips for using PeopleCode, the interaction of PeopleCode and the Component Processor, and a number of other specialized topics, such as the use of the PeopleCode debugger and referencing data in the component buffer.

The accompanying books, the Enterprise 8.46: PeopleCode API Reference and the Enterprise 8.46: PeopleCode Language Reference, contain the reference material for the PeopleCode language. The chapters in these books describe the syntax and fundamental elements of the PeopleCode language.

The “About These PeopleBooks” preface contains general product line information, such as related documentation, common page elements, and typographical conventions. This preface also contains a glossary with useful terms that are used in PeopleBooks.

Click to jump to top of pageClick to jump to parent topicPeopleCode Typographical Conventions

Throughout this book, we use typographical conventions to distinguish between different elements of the PeopleCode language, such as bold to indicate function names, italics for arguments, and so on.

Please take a moment to review the following typographical cues:

Font Type

Description

monospace font

Indicates a PeopleCode program or other example

Keyword

In PeopleCode syntax, items in keyword font indicate function names, method names, language constructs, and PeopleCode reserved words that must be included literally in the function call.

Variable

In PeopleCode syntax, items in variable font are placeholders for arguments that your program must supply.

...

In PeopleCode syntax, ellipses indicate that the preceding item or series can be repeated any number of times.

{Option1|Option2}

In PeopleCode syntax, when there is a choice between two options, the options are enclosed in curly braces and separated by a pipe.

[ ]

In PeopleCode syntax optional items are enclosed in square brackets.

&Parameter

In PeopleCode syntax an ampersand before a parameter indicates that the parameter is an already instantiated object.

Click to jump to top of pageClick to jump to parent topicAbout These PeopleBooks

A companion PeopleBook called About These PeopleBooks contains general information, including:

See Also

About These PeopleBooks Preface

Using PeopleBooks

Managing the PeopleSoft Online Library and PeopleBooks

ISO Country and Currency Codes

Glossary of PeopleSoft Terms