Guardian Procedure Calls Reference Manual (G06.25+)

Guardian Procedure Calls (G)
Guardian Procedure Calls Reference Manual—522629-013
6-36
GROUP_GETINFO_ Procedure
on input, if group-curlen is 0 or omitted, specifies the group ID for which
information is to be returned.
On output, if
group-name is specified and group-curlen is not 0, this
parameter returns the group ID corresponding to the specified group name.
group-id is a value in the range 0 through 65,535.
is-auto-delete output
INT .EXT:ref:1
indicates whether the specified group is automatically deleted when it no longer
contains members. This parameter returns the following values:
-1 The group is deleted when it becomes empty.
0 The group is not deleted when it becomes empty.
descrip:descrip-maxlen ouput:input
STRING .EXT:ref:*, INT:value
if present and if
descrip-maxlen is not 0, returns a string containing a
description of the specified group. The maximum length of
descrip is 255.
descrip-maxlen specifies the length of the string variable descrip in bytes.
This parameter pair is required if
descriplen is specified.
descriplen output
INT .EXT:ref:1
is the length in bytes of the string returned in
descrip.
This parameter is required if
descrip:descrip-maxlen is specified.
Considerations
Either group-name or group-id must be supplied. If both parameters are supplied
and
group-curlen is greater than zero, group-name is treated as an input
parameter and
group-id is treated as an output parameter. If both parameters are
supplied and
group-curlen is zero, group-id is treated as an input parameter.
Example
!get the descriptive text, if any, on the specified group ID
error :=
GROUP_GETINFO_ ( ,,group^id,,descrip:maxlen,real^len );