OMFget_str_val_mode

Synopsis

INTEGER FUNCTION OMFget_str_val_mode(object_id,
      . cval,
      . maxlen,
      . mode)
#include <avs/omf.inc>
INTEGER object_id(OIDSIZ)
INTEGER maxlen, mode
CHARACTER*(*) cval

Description

For a complete description of this function, see OMget_str_val.

Arguments

object_id

The id of an object, expressed as an integer.

cval

A character string specifying the object's value. This call requires that you pass a locally defined character variable and doesn't allow for memory allocation.

maxlen

The maximum number of characters to get, expressed as an integer.

mode

Translation mode, expressed as an integer -- 0 for translation to take place; OM_STR_NO_I18N for no translation.

Returned value

The status code (see OMget_str_val).

Examples

#include <avs/omf.inc>
     INTEGER parent_object(OIDSIZ), cval_id(OIDSIZ)
     CHARACTER*30 value
     ...
     IF (OMFfind_subobj(parent_object,
     . OMstr_to_name('cval'),
     . OM_OBJ_RD,
     . cval_id)
.NE. 1)
     . PRINT*,'Error searching for cval'
C
      IF (OMFget_str_val_mode(cval_id,
     . value,
     . LEN(value),
     . OM_STR_NO_I18N) .NE. 1)
. PRINT*,'Error getting value of object cval'

See Also

OMFset_str_val

OMFget_str_val