Returns the list of contact groups. Contacts are users
to whom notification messages can be sent. Contact groups can be either
defined locally on the system or in a global list. The setting of
the DB2® administration server
(DAS) configuration parameter contact_host determines whether the
list is local or global.
API include file
db2ApiDf.h
API and data structure syntax
SQL_API_RC SQL_API_FN
db2GetContactGroups (
db2Uint32 versionNumber,
void * pParmStruct,
struct sqlca * pSqlca);
typedef SQL_STRUCTURE db2GetContactGroupsData
{
db2Uint32 ioNumGroups;
struct db2ContactGroupDesc *poGroups;
} db2GetContactGroupsData;
typedef SQL_STRUCTURE db2ContactGroupDesc
{
char *poName;
char *poDescription;
} db2ContactGroupDesc;
db2GetContactGroups API parameters
- versionNumber
- Input. Specifies the version and release level of the structure
passed as the second parameter pParmStruct.
- pParmStruct
- Input. A pointer to the db2GetContactGroupsData structure.
- pSqlca
- Output. A pointer to the sqlca structure.
db2GetContactGroupsData data structure parameters
- ioNumGroups
- The number of groups. If oNumGroups = 0 and poGroups = NULL, it
will contain the number of db2ContactGroupDesc structures needed in
poGroups.
- poGroups
- Output. A pointer to the db2ContactGroupDesc structure.
db2ContactGroupDesc data structure parameters
- poName
- Output. The group name. This parameter should be preallocated
by the caller with the respective maximum size.
- poDescription
- Output. The group description. This parameter should be preallocated
by the caller with the respective maximum size.
Usage notes
This API is not supported on UNIX and Linux.
However, you can access the same functionality through the SQL interface.