GH_IWriterAddComment Method

Adds a text comment to this chunk. Comments are serialized only if the output flavour is a human readable format. Comments are never deserialized, they are purely for the benefit of the humans reading the file data.

Namespace: GH_IO.Serialization
Assembly: GH_IO (in GH_IO.dll)

Syntax

Copy

void AddComment(
	string comment_text
)

Sub AddComment ( 
	comment_text As String
)

Parameters

comment_text: Type: SystemString
The content of the comment, text might be altered if it contains invalid characters for a chosen format flavour.

Exceptions

Exception	Condition
ArgumentNullException	Thrown if the content text is either null or empty.

Reference

GH_IWriter Interface

GH_IO.Serialization Namespace

GH_IWriterAddLanguageSpecificTextSet("LST78147C7C_0?cpp=::|nu=.");AddComment Method

Parameters

Reference

GH_IWriterAddComment Method