Programming Reference: Persistent Objects

# Programming Reference

## Persistent Objects

This section contains help functions for use with persistent objects. At initialization time (InitXXXX or InitXXXXFromStorage), the client should call the appropriate initialization functions. At clone-into time, the client should call the corresponding clone functions. At externalization time, the client should call the appropriate update functions.

The following lists the persistent object functions:

- CloneDateInfo
- CloneModificationInfo
- InitDateInfo
- InitModificationInfo
- UpdateDateInfo
- UpdateModificationInfo

### CloneDateInfo

This function clones date information in a storage unit at clone-into time.

Signature

    void CloneDateInfo (Environment *ev,
                        ODStorageUnit *fromSU,
                        ODStorageUnit *toSU)

Parameters

ev (Environment *) - input

  The SOM environment.

fromSU (ODStorageUnit *) - input

  The storage unit from which information is to be cloned.

toSU (ODStorageUnit *) - input

  The storage unit to which information is to be cloned.

Returns

None.

### CloneModificationInfo

This function clones modification information in a storage unit at clone-into time.

Signature

    void CloneModificationInfo (Environment *ev,
                                ODStorageUnit *fromSU,
                                ODStorageUnit *toSU)

Parameters

ev (Environment *) - input

  The SOM environment.

fromSU (ODStorageUnit *) - input

  The storage unit from which information is to be cloned.

toSU (ODStorageUnit *) - input

  The storage unit to which information is to be cloned.

Returns

None.

### InitDateInfo

This function initializes date information in a storage unit at initialization time.

Signature

    void InitDateInfo (Environment *ev,
                       ODStorageUnit *su)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit into which data is to be added.

Returns

None.

### InitModificationInfo

This function initializes modification information in a storage unit at initialization time.

Signature

    void InitModificationInfo (Environment *ev,
                               ODStorageUnit *su)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to which modification information is to be added.

Returns

None.

### UpdateDateInfo

This function updates date information in a storage unit at externalization time.

Signature

    void UpdateDateInfo (Environment *ev,
                         ODStorageUnit *su)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to externalize to.

Returns

None.

### UpdateModificationInfo

This function updates modification information in a storage unit at externalization time.

Signature

    void UpdateModificationInfo (Environment *ev,
                                 ODStorageUnit *su)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to externalize to.

Returns

None.

[ Top | Previous | Next | Contents | Index | Documentation Homepage ]