Syntax

[C/C++:]
void gSetSegComment(int nseg, char comment[]);

[F90:]
subroutine gSetSegComment(nseg,comment)
integer, intent(in) :: nseg
character*(*), intent(in) :: comment

Arguments

nseg
Picture segment number

comment
Segment comment string

Description

The routine gSetSegComment() assigns the string comment to the previously opened segment nseg It may be used multiple times to reassign the segment comment at any time whilst the segment exists.

An error will occur if no storage has been allocated prior to the segment being created. Thus the routine gSetSegCommentLen() must be called prior to using this routine.

The segment comment may be truncated if the length of the comment string is less than the allocated segment comment storage length as set by gSetSegCommentLen().

The comment string may be enquired using gEnqSegComment().

See Also

gEnqSegComment Usage
gEnqSegComment
gSetSegCommentLen

---