.\" @(#)$RCSfile: dpns_getgrpmap.man,v $ $Revision: 1.1 $ $Date: 2007/12/13 06:15:14 $ CERN IT-GD/ITR Jean-Philippe Baud
.\" Copyright (C) 2007 by CERN/IT/GD/ITR
.\" All rights reserved
.\"
.TH DPNS_GETGRPMAP 3 "$Date: 2007/12/13 06:15:14 $" DPNS "DPNS Library Functions"
.SH NAME
dpns_getgrpmap \- get all existing groups from virtual gid table
.SH SYNOPSIS
.B #include <sys/types.h>
.br
\fB#include "dpns_api.h"\fR
.sp
.BI "int dpns_getgrpmap (int *" nbentries ,
.BI "struct dpns_groupinfo **" grp_entries )
.SH DESCRIPTION
.B dpns_getgrpmap
gets all the existing groups from the virtual gid table.
.TP
.I nbentries
will be set to the number of entries in the array of group infos.
.TP
.I grp_entries
will be set to the address of an array of dpns_groupinfo structures allocated
by the API. The client application is responsible for freeing the array when not
needed anymore.
.LP 
This function requires ADMIN privilege.
.SH RETURN VALUE
This routine returns 0 if the operation was successful or -1 if the operation
failed. In the latter case,
.B serrno
is set appropriately.
.SH ERRORS
.TP 1.3i
.B EACCES
The caller does not have ADMIN privilege.
.TP
.B ENOMEM
Memory could not be allocated for unmarshalling the reply.
.TP
.B EFAULT
.I nbentries
or
.I grp_entries
is a NULL pointer.
.TP
.B SENOSHOST
Host unknown.
.TP
.B SENOSSERV
Service unknown.
.TP
.B SECOMERR
Communication error.
.TP
.B ENSNACT
Name server is not running or is being shutdown.