
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.
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
Returns
| kODTrue | The operation was successful. |
| kODFalse | The operation was unsuccessful. |
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
| kODTrue | The focus was successful. |
| kODFalse | The focus was unsuccessful. |
This function removes the property of the specified storage unit.
Signature
#include <StorUtil.h>
void ODSURemoveProperty (Environment *ev,
ODStorageUnit *su,
ODPropertyName prop)
|
Parameters
Returns
None.