Daylight v4.9
Release Date: 1 February 2008

Name

dt_setstring - set the string value of a named property

Generic Prototype

dt_setstring(dt_Handle, dt_String, dt_String) => dt_Boolean

C Prototype

#include "dt_smiles.h"

dt_Boolean dt_setstring(dt_Handle object, dt_Integer nlen, dt_String pname, dt_Integer vlen, dt_String value)

FORTRAN Prototype

include 'dt_f_smiles.inc'

logical dt_f_setstring(object, pname, value)

integer*4 object
character*() pname
character*() value

Description

Causes the named property to be created or modified. Sets the value of the named property 'pname' to 'value'. Also sets the property type of the named property to be set to DX_PROP_STRING (returned by dt_proptype(3)).

Named properties can be set for any object in the toolkit. The properties are owned by the object, and become invalid if the object is deallocated. A property name may be any valid string (see dt_setstringvalue(3)).

Setting a string property to 'invalid string' effectively removes the property from the object. Calls to dt_proptype(object, pname) will return DX_PROP_NOPROP after this operation.

Return Value

Returns the success (TRUE) or failure (FALSE) of the operation.

Related Topics

dt_appendstring(3) dt_proptype(3) dt_setstringvalue(3) dt_string(3)