beautypg.com

Using soups 11 – Apple Newton Programmer’s Newton 2.0 (for Newton 2.0) User Manual

Page 464

background image

C H A P T E R 1 1

Data Storage and Retrieval

11-32

Using Newton Data Storage Objects

method retrieves the value of a specified slot in the store information frame. Its
corollary, the

SetInfo

store method, writes the value of a specified slot in this frame.

Using Soups

11

This section discusses the functions and methods used to work with soup objects.
Individual entries in soups and union soups are manipulated by means of queries,
cursors, and entry functions, as described in subsequent sections of this chapter.
This section describes procedures for

creating soups and indexes

retrieving existing soups

indexing existing soups

reading and writing soup data

accessing information about the soup itself and the store on which it resides

removing soups

Naming Soups

11

When creating soups, you need to follow certain naming conventions in order to
avoid name collisions with other applications’ soups. Following these conventions
also makes your own soups more easily identifiable.

If your application creates only one soup, you can use your package name as the
name of its soup. Your package name is created by using a colon (

:

) to append

your package’s Extras Drawer name to your unique developer signature. For
example, if your developer signature is

"myCompany"

and you are creating a

package that appears in the Extras Drawer with the name

"foo"

, concatenating

these two values produces the

"foo:myCompany"

package name.

If your application creates multiple soups, use another colon, followed by your
package name, as a suffix to a descriptive soup name. For example,

"soup1:foo:myCompany"

and

"soup2:foo:myCompany"

would be

acceptable soup names unlikely to duplicate those used by other applications.

Normally, each soup appears under its own icon in the Extras Drawer. If your
application creates multiple soups, it is recommended that you group them under a
single Extras Drawer icon. For more information, see “About Icons and the Extras
Drawer” on page 19-38 in Chapter 19, “Built-in Applications and System Data.”

For additional information regarding naming conventions for your developer
signature and other items, see “Developer Signature Guidelines” on page 2-9 in
Chapter 2, “Getting Started.”