Syntax

[C/C++:]
void gEnqSegComment(int nseg, int *len, char comment, int clen);

[F90:]
subroutine gEnqSegComment(nseg, len, comment)
integer, intent(in) :: nseg
integer, intent(out) :: len
character*(*), intent(out) :: comment

Arguments

nseg
Picture segment number

len
Length of segment comment

= 0,	No segment comment available

> 0,	Length of segment comment string returned in bytes

comment
Segment comment string

clen
Length of comment string (C/C++ only)

Description

The routine gEnqSegComment() returns the comment string assigned to the segment nseg, where one has been set by the routine gSetSegComment().

If storage has not been allocated using gSetSegCommentLen() or no comment has been stored len will return 0.

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

See Also

gEnqSegComment Usage
gSetSegComment
gSetSegCommentLen

---