E57 Foundation API v1.1.312  Aug. 10, 2011
StringNode ( ImageFile  destImageFile,
const ustring  value = "" 
) [explicit]

Create an element storing a Unicode character string.

Parameters:
[in]destImageFileThe ImageFile where the new node will eventually be stored.
[in]valueThe Unicode character string value of the element, in UTF-8 encoding.

The StringNode class corresponds to the ASTM E57 standard String element. See the class discussion at bottom of StringNode page for more details.

The destImageFile indicates which ImageFile the StringNode will eventually be attached to. A node is attached to an ImageFile by adding it underneath the predefined root of the ImageFile (gotten from ImageFile::root). It is not an error to fail to attach the StringNode to the destImageFile. It is an error to attempt to attach the StringNode to a different ImageFile.

If the StringNode is to be used in a CompressedVectorNode prototype, it is recommended to specify a value = "" (the default value).

Precondition:
The destImageFile must be open (i.e. destImageFile.isOpen() must be true).
The destImageFile must have been opened in write mode (i.e. destImageFile.isWritable() must be true).
Returns:
A smart StringNode handle referencing the underlying object.
Exceptions:
E57_ERROR_IMAGEFILE_NOT_OPEN
E57_ERROR_FILE_IS_READ_ONLY
E57_ERROR_INTERNALAll objects in undocumented state
See also:
StringCreate.cpp example, StringNode::value, Node, CompressedVectorNode, CompressedVectorNode::prototype
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines