cx_set_rprop

NAME

cx_set_rprop - set the real value of a named property

SYNOPSIS: ANSI-C USAGE

#include "cx.h"
cx_Object cx_set_rprop(cx_Object ob, cx_String pname, cx_Real rval);

SYNOPSIS: FORTRAN USAGE

include 'cx_f.inc'
real*8 rval
integer*4 ob, prop
character*(*) pname, cx_f_set_rprop()
prop = cx_f_set_rprop(ob, pname, rval)

Description

Sets the real value of the object's property with the given property name using the sprintf(3) format cx_realfmt(). If the property exists, its old value is replaced by `rval'; if not, the property is created with the value `rval'.

This is one of the 8 functions designed to provide a high-level interface to CX properties (cx_sprop, cx_set_sprop, cx_iprop, cx_set_iprop, cx_rprop, cx_set_rprop, cx_realfmt and cx_set_realfmt).

Return Value

Returns a handle to the property object or NULL on error.

Diagnostics

NULL is quietly returned if either of the first two arguments are NULL.

Bugs

The returned property object is not particularly useful to the high-level CX programmer and should be used only for an indication of success. The interface could be simplified (slightly) by making this function return TRUE or FALSE.

Back to index.