Programming Reference: Standard-Typed Values

# Programming Reference

## Standard-Typed Values

The functions in this section read to and write from standard-typed values storage units.

The following lists the functions and macros for standard-typed values.

- ODGetBooleanProp
- ODGetISOStrProp
- ODGetITextProp
- ODGetMatrixProp
- ODGetPointProp
- ODGetPolygonProp
- ODGetRectProp
- ODGetSLongProp
- ODGetSShortProp
- ODGetStrongSURefProp
- ODGetTime_TProp
- ODGetTypeListProp
- ODGetULongProp
- ODGetUShortProp
- ODGetWeakSURefProp
- ODSetBooleanProp
- ODSetISOStrProp
- ODSetITextProp
- ODSetMatrixProp
- ODSetPointProp
- ODSetPolygonProp
- ODSetRectProp
- ODSetSLongProp
- ODSetSShortProp
- ODSetStrongSURefProp
- ODSetTime_TProp
- ODSetTypeListProp
- ODSetULongProp
- ODSetUShortProp
- ODSetWeakSURefProp
- ODSUAddPropValue
- ODSUForceFocus
- ODSUExistsThenFocus
- ODSURemoveProperty

### ODGetBooleanProp

This function returns the Boolean value of the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    ODBoolean ODGetBooleanProp (Environment *ev,
                                ODStorageUnit *su,
                                ODPropertyName prop,
                                ODValueType val)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be queried.

prop (ODPropertyName) - input

  The property to be queried.

val (ODValueType) - input

  The value to be queried.

Returns

rv (ODBoolean) - returns

  The Boolean value of the storage unit, property, and value.

  kODTrue | The operation was successful.
  kODFalse | The operation was unsuccessful.

### ODGetISOStrProp

This function returns the ISO string of the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    ODISOStr ODGetISOStrProp (Environment *ev,
                              ODStorageUnit *su,
                              ODPropertyName prop,
                              ODValueType val,
                              ODISOStr value,
                              ODULong *size)

Parameters

ev (Environment *) - input

  The SOM Environment.

su (ODStorageUnit *) - input

  The storage unit to be queried.

prop (ODPropertyName) - input

  The property to be queried.

val (ODValueType) - input

  The value to be queried.

value (ODISOStr) - in/out

  The ISO string value of the specified storage unit, property and value.

size (ODULong *) - in/out

  On input, the length of the longest ISO string written to the value parameter, including the null-terminator. On output, the size is updated with the actual number of bytes read.

Returns

rv (ODISOStr) - returns

  The ISO string value of the specified storage unit, property and value.

### ODGetITextProp

This function returns an IText structure of the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    ODIText *ODGetITextProp (Environment *ev,
                             ODStorageUnit *su,
                             ODPropertyName prop,
                             ODValueType val,
                             ODIText *name)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be queried.

prop (ODPropertyName) - input

  The property to be queried.

val (ODValueType) - input

  The value to be queried.

name (ODIText *) - in/out

  The IText structure of the specified storage unit, property and value. If this value is kODNULL, the existing buffer of text in IText is allocated and filled; otherwise, the buffer of text is disposed of and a new one is allocated and filled.

Returns

rv (ODIText *) - returns

  The IText structure of the specified storage unit, property and value.

### ODGetMatrixProp

This function returns the matrix of the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    ODMatrix *ODGetMatrixProp (Environment *ev,
                               ODStorageUnit *su,
                               ODPropertyName prop,
                               ODValueType val,
                               ODMatrix *value)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be queried.

prop (ODPropertyName) - input

  The property to be queried.

val (ODValueType) - input

  The value to be queried.

value (ODMatrix *) - output

  The matrix value of the specified storage unit, property, and value.

Returns

rv (ODMatrix *) - returns

  The matrix value of the specified storage unit, property, and value.

### ODGetPointProp

This function returns a point value of the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    ODPoint *ODGetPointProp (Environment *ev,
                             ODStorageUnit *su,
                             ODPropertyName prop,
                             ODValueType val,
                             ODPoint *value)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be queried.

prop (ODPropertyName) - input

  The property to be queried.

val (ODValueType) - input

  The value to be queried.

value (ODPoint *) - output

  The point value of the specified storage unit, property, and value.

Returns

rv (ODPoint *) - returns

  The point value of the specified storage unit, property, and value.

### ODGetPolygonProp

This function returns a polygon value of the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    ODPolygon *ODGetPolygonProp (Environment *ev,
                                 ODStorageUnit *su,
                                 ODPropertyName prop,
                                 ODValueType val,
                                 ODPolygon *value)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be queried.

prop (ODPropertyName) - input

  The property to be queried.

val (ODValueType) - input

  The value to be queried.

value (ODPolygon *) - output

  The polygon value of the specified storage unit, property, and value.

Returns

rv (ODPolygon *) - returns

  The polygon value of the specified storage unit, property, and value.

### ODGetRectProp

This function returns a rectangle value of the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    ODRect *ODGetRectProp (Environment *ev,
                           ODStorageUnit *su,
                           ODPropertyName prop,
                           ODValueType val,
                           ODRect *value)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be queried.

prop (ODPropertyName) - input

  The property to be queried.

val (ODValueType) - input

  The value to be queried.

value (ODRect *) - input

  The rectangle value of the specified storage unit, property, and value.

Returns

rv (ODRect *) - returns

  The rectangle value of the specified storage unit, property, and value.

### ODGetSLongProp

This function returns a signed long integer returned the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    ODSLong ODGetSLongProp (Environment *ev,
                            ODStorageUnit *su,
                            ODPropertyName prop,
                            ODValueType val)

Parameters

ev (Environment *) - input

  The SOM Environment.

su (ODStorageUnit *) - input

  The storage unit to be queried.

prop (ODPropertyName) - input

  The property to be queried.

val (ODValueType) - input

  The value to be queried.

Returns

rv (ODSLong) - returns

  The signed-long integer of the specified storage unit, property, and value.

### ODGetSShortProp

This function returns a singed short integer of the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    ODSShort ODGetSShortProp (Environment *ev,
                              ODStorageUnit *su,
                              ODPropertyName prop,
                              ODValueType val)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be queried.

prop (ODPropertyName) - input

  The property to be queried.

val (ODValueType) - input

  The value to be queried.

Returns

rv (ODSShort) - returns

  The signed-short integer read of the specified storage unit, property, and value.

### ODGetStrongSURefProp

This function returns a strong storage unit reference of the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    ODID ODGetStrongSURefProp (Environment *ev,
                               ODStorageUnit *su,
                               ODPropertyName prop,
                               ODValueType val)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be queried.

prop (ODPropertyName) - input

  The property to be queried.

val (ODValueType) - input

  The value to be queried.

Returns

rv (ODID) - returns

  The strong storage-unit reference of the storage unit, property, and value. If the storage unit reference was not found, 0 is returned.

### ODGetTime_TProp

This function returns a time data structure of the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    ODTime ODGetTime_TProp (Environment *ev,
                            ODStorageUnit *su,
                            ODPropertyName prop,
                            ODValueType val)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be queried.

prop (ODPropertyName) - input

  The property to be queried.

val (ODValueType) - input

  The value to be queried.

Returns

rv (ODTime) - returns

  The time data structure of the specified storage unit, property, and value.

### ODGetTypeListProp

This function returns a type list of the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    void ODGetTypeListProp (Environment *ev,
                            ODStorageUnit *su,
                            ODPropertyName prop,
                            ODValueType val,
                            ODTypeList *typeList)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be queried.

prop (ODPropertyName) - input

  The property to be queried.

val (ODValueType) - input

  The value to be queried.

typeList (ODTypeList *) - output

  The type list value of the specified storage unit, property, and value. The property value containing 'n' elements has 'n+1' offsets. The first n offsets indicate the positions of the corresponding ISO string. The last offset equals the size of the value and is immediately before the first character of the first ISOString. For example, a property value representing an empty type list is 4 bytes long and contains a single offset of value 4.

Returns

None.

### ODGetULongProp

This function returns an unsigned-long integer of the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    ODULong ODGetULongProp (Environment *ev,
                            ODStorageUnit *su,
                            ODPropertyName prop,
                            ODValueType val)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be queried.

prop (ODPropertyName) - input

  The property to be queried.

val (ODValueType) - input

  The value to be queried.

Returns

rv (ODULong) - returns

  The unsigned-long integer of the specified storage unit, property, and value.

### ODGetUShortProp

This function returns a signed-short integer of the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    ODUShort ODGetUShortProp (Environment *ev,
                              ODStorageUnit *su,
                              ODPropertyName prop,
                              ODValueType val)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be queried.

prop (ODPropertyName) - input

  The property to be queried.

val (ODValueType) - input

  The value to be queried.

Returns

rv (ODUShort) - returns

  The signed-short integer of the specified storage unit, property, and value.

### ODGetWeakSURefProp

This function returns a weak storage-unit reference of the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    ODID ODGetWeakSURefProp (Environment *ev,
                             ODStorageUnit *su,
                             ODPropertyName prop,
                             ODValueType val)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be queried.

prop (ODPropertyName) - input

  The property to be queried.

val (ODValueType) - input

  The value to be queried.

Returns

rv (ODID) - returns

  The weak storage unit ID of the specified storage unit, property, and value.

### ODSetBooleanProp

This function sets a Boolean in the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    void ODSetBooleanProp (Environment *ev,
                           ODStorageUnit *su,
                           ODPropertyName prop,
                           ODValueType val,
                           ODBoolean value)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be set.

prop (ODPropertyName) - input

  The property to be set.

val (ODValueType) - input

  The value to be set.

value (ODBoolean) - input

  The Boolean value to set in the specified storage unit, property, and value.

Returns

None.

### ODSetISOStrProp

This function sets an ISO string value in the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    void ODSetISOStrProp (Environment *ev,
                          ODStorageUnit *su,
                          ODPropertyName prop,
                          ODValueType val,
                          ODISOStr value)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be set.

prop (ODPropertyName) - input

  The property to be set.

val (ODValueType) - input

  The value to be set.

value (ODISOStr) - output

  The ISO string to set in the specified storage unit, property, and value.

Returns

None.

### ODSetITextProp

This function sets an IText structure in the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    void ODSetITextProp (Environment *ev,
                         ODStorageUnit *su,
                         ODPropertyName prop,
                         ODValueType val,
                         ODIText *name)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be set.

prop (ODPropertyName) - input

  The property to be set.

val (ODValueType) - input

  The value to be set.

name (ODIText *) - input

  The IText structure to set in the specified storage unit, property, and value.

Returns

None.

### ODSetMatrixProp

This function sets the matrix value in the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    void ODSetMatrixProp (Environment *ev,
                          ODStorageUnit *su,
                          ODPropertyName prop,
                          ODValueType val,
                          ODMatrix *value)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be set.

prop (ODPropertyName) - input

  The property to be set.

val (ODValueType) - input

  The value to be set.

value (ODMatrix *) - input

  The matrix value to set in the specified storage unit, property, and value.

Returns

None.

### ODSetPointProp

This function sets the point value in the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    void ODSetPointProp (Environment *ev,
                         ODStorageUnit *su,
                         ODPropertyName prop,
                         ODValueType&rb.val,
                         ODPoint *value)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be set.

prop (ODPropertyName) - input

  The property to be set.

val (ODValueType) - input

  The value to be set.

value (ODPoint *) - output

  The point value to set in the storage unit, property, and value.

Returns

None.

### ODSetPolygonProp

This function sets the polygon value in the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    void ODSetPolygonProp (Environment *ev,
                           ODStorageUnit *su,
                           ODPropertyName prop,
                           ODValueType val,
                           const ODPolygon *value)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be set.

prop (ODPropertyName) - input

  The property to be set.

val (ODValueType) - input

  The value to be set.

value (const ODPolygon *) - output

  The polygon value to set in the storage unit, property, and value.

Returns

None.

### ODSetRectProp

This function sets the rectangle value in the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    void ODSetRectProp (Environment *ev,
                        ODStorageUnit *su,
                        ODPropertyName prop,
                        ODValueType val,
                        ODRect *value)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be set.

prop (ODPropertyName) - input

  The property to be set.

val (ODValueType) - input

  The value to be set.

value (ODRect *) - input

  The rectangle value to set in the specified storage unit, property, and value.

Returns

None.

### ODSetSLongProp

This function sets the signed-long value in the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    void ODSetSLongProp (Environment *ev,
                         ODStorageUnit *su,
                         ODPropertyName prop,
                         ODValueType val,
                         ODSLong value)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be set.

prop (ODPropertyName) - input

  The property to be set.

val (ODValueType) - input

  The value to be set.

value (ODSLong) - input

  The signed-long value to set in the specified storage unit, property, and value.

Returns

None.

### ODSetSShortProp

This function sets the signed-short value in the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    void ODSetSShortProp (Environment *ev,
                          ODStorageUnit *su,
                          ODPropertyName prop,
                          ODValueType val,
                          ODSShort value)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be set.

prop (ODPropertyName) - input

  The property to be set.

val (ODValueType) - input

  The value to be set.

value (ODSShort) - input

  The signed-short value to set in the specified storage unit, property, and value.

Returns

None.

### ODSetStrongSURefProp

This function sets a strong storage-unit reference in the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    void ODSetStrongSURefProp (Environment *ev,
                               ODStorageUnit *su,
                               ODPropertyName prop,
                               ODValueType val,
                               ODID id)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be set.

prop (ODPropertyName) - input

  The property to be set.

val (ODValueType) - input

  The value to be set.

id (ODID) - input

  The strong storage unit ID to set in the specified storage unit, property, and value.

Returns

None.

### ODSetTime_TProp

This function sets the time information in the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    void ODSetTime_TProp (Environment *ev,
                          ODStorageUnit *su,
                          ODPropertyName prop,
                          ODValueType val,
                          ODTime value)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be set.

prop (ODPropertyName) - input

  The property to be set.

val (ODValueType) - input

  The value to be set.

value (ODTime) - input

  The time information to set in the specified storage unit, property, and value.

Returns

None.

### ODSetTypeListProp

This function sets the type list value in the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    void ODSetTypeListProp (Environment *ev,
                            ODStorageUnit *su,
                            ODPropertyName prop,
                            ODValueType val,
                            ODTypeList *typeList)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be set.

prop (ODPropertyName) - input

  The property to be set.

val (ODValueType) - input

  The value to be set.

typeList (ODTypeList *) - input

  The type list value to set in the specified storage unit, property, and value.

Returns

None.

### ODSetULongProp

This function sets the unsigned-long integer in the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    void ODSetULongProp (Environment *ev,
                         ODStorageUnit *su,
                         ODPropertyName prop,
                         ODValueType val,
                         ODULong value)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be set.

prop (ODPropertyName) - input

  The property to be set.

val (ODValueType) - input

  The value to be set.

value (ODULong) - input

  The unsigned-long integer to set in the specified storage unit. property, and value.

Returns

None.

### ODSetUShortProp

This function sets the unsigned-short integer in the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    void ODSetUShortProp (Environment *ev,
                          ODStorageUnit *su,
                          ODPropertyName prop,
                          ODValueType val,
                          ODUShort value)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be set.

prop (ODPropertyName) - input

  The property to be set.

val (ODValueType) - input

  The value to be set.

value (ODUShort) - output

  The unsigned short integer to set in the specified storage unit, property, and value.

Returns

None.

### ODSetWeakSURefProp

This function sets a weak storage-unit reference in the specified storage unit, property, and value.

Signature

    #include <StdTypIO.h>

    void ODSetWeakSURefProp (Environment *ev,
                             ODStorageUnit *su,
                             ODPropertyName prop,
                             ODValueType val,
                             ODID id)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit to be set.

prop (ODPropertyName) - input

  The property to be set.

val (ODValueType) - input

  The value to be set.

id (ODID) - input

  The weak storage-unit ID to set in the specified storage unit, property, and value.

Returns

None.

### ODSUAddPropValue

This function adds the property and value to the specified storage unit.

Signature

    #include <StorUtil.h>

    void ODSUAddPropValue (Environment *ev,
                           ODStorageUnit *su,
                           ODPropertyName prop,
                           ODValueType val)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - in/out

  The storage unit to be set.

prop (ODPropertyName) - input

  The property to set in the storage unit..

val (ODValueType) - input

  The value to set in the storage unit..

Returns

None.

### ODSUForceFocus

This function sets the focus to the specified property and value in a storage unit. If the property or value does not exist, it is created.

Signature

    #include <StorUtil.h>

    void ODSUForceFocus (Environment *ev,
                         ODStorageUnit *su,
                         ODPropertyName prop,
                         ODValueType val)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit whose focus is to be set.

prop (ODPropertyName) - input

  The property name of the specified focus.

val (ODValueType) - input

  The value type of the specified focus.

Returns

None.

### ODSUExistsThenFocus

This function sets the focus to the specified property and value only if they already exist in the specified storage unit.

Signature

    #include <StorUtil.h>

    ODBoolean ODSUExistsThenFocus (Environment *ev,
                                   ODStorageUnit *su,
                                   ODPropertyName prop,
                                   ODValueType val)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit whose focus is to be set.

prop (ODPropertyName) - input

  The property name of the specified focus.

val (ODValueType) - input

  The value type of the specified focus.

Returns

rv (ODBoolean) - returns

  A flag indicating whether the focus was successful.

  kODTrue | The focus was successful.
  kODFalse | The focus was unsuccessful.

### ODSURemoveProperty

This function removes the property of the specified storage unit.

Signature

    #include <StorUtil.h>

    void ODSURemoveProperty (Environment *ev,
                             ODStorageUnit *su,
                             ODPropertyName prop)

Parameters

ev (Environment *) - input

  The SOM environment.

su (ODStorageUnit *) - input

  The storage unit whose property is to be removed.

prop (ODPropertyName) - input

  The property to be removed.

Returns

None.

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