Arbortext Command Language > Functions by Alphabetical Listing > oid_read_only
  
oid_read_only
oid_read_only (oid[, value])
This function returns the current “read only” state for the specified oid. The oid-level read only state is a feature that is not manipulated by the default Arbortext Editor features and functions. The oid-level read only state is only changed/used if an ACL programmer specifically uses this function to change the read only state.
If the specified oid has been set to a “read only” state, the function returns a one (1). If the oid has not been set to a “read only” state), the function returns a zero (0).
If the optional value parameter is included, the function still returns the current “read only” state of the specified oid, but also sets the “read only” state to the specified value. The value parameter must be either a one (1) for “read only”, or a zero (0) for “not read only”.
Examples:
$mod = oid_read_only(oid_current_tag())
$ret = oid_read_only(oid_next(),1)