Programming Reference: Window Properties

# Programming Reference

## Window Properties

This section describes the functions used to get window properties from a frame.

The following lists the window properties functions.

- BeginGetWindowProperties
- EndGetWindowProperties

### BeginGetWindowProperties

This function returns window properties from the storage unit referred to in the frame's kODPropWindowProperties.

Signature

    ODBoolean BeginGetWindowProperties (Environment *ev,
                                        ODFrame *frame,
                                        WindowProperties *properties)

Parameters

ev (Environment *) - input

  The SOM environment.

frame (ODFrame *) - input

  The frame whose window properties are to be returned.

properties (WindowProperties *) - output

  The window properties of the specified frame.

Returns

rv (ODBoolean) - returns

  A flag indicating whether the annotation exist.

  kODTrue | The annotation exists.
  kODFalse | The annotation does not exist.

### EndGetWindowProperties

This function releases the source frame.

Signature

    void EndGetWindowProperties (Environment *ev,
                                 WindowProperties *properties)

Parameters

ev (Environment *) - input

  The SOM environment.

properties (WindowProperties *) - input

  The window properties of the source frame to be released.

Returns

None.

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