DB2 Version 9.7 for Linux, UNIX, and Windows

db2GetContactGroup API - Get the list of contacts in a single contact group to whom notification messages can be sent

Returns the contacts included in a single contact group. Contacts are users to whom notification messages can be sent. Contacts 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.

Authorization

None

Required connection

None

API include file

db2ApiDf.h

API and data structure syntax

SQL_API_RC SQL_API_FN
  db2GetContactGroup (
   db2Uint32 versionNumber,
   void * pParmStruct,
   struct sqlca * pSqlca);

typedef SQL_STRUCTURE db2ContactGroupData
{
   char *pGroupName;
   char *pDescription;
   db2Uint32 numContacts;
   struct db2ContactTypeData *pContacts;
} db2ContactGroupData;

typedef SQL_STRUCTURE db2ContactTypeData
{
   db2Uint32 contactType;
   char *pName;
} db2ContactTypeData;

db2GetContactGroup 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 db2ContactGroupData structure.
pSqlca: Output. A pointer to the sqlca structure.

db2ContactGroupData data structure parameters

pGroupName: Input. The name of the group to be retrieved.
pDescription: The description of the group.
numContacts: The number of pContacts.
pContacts: A pointer to the db2ContactTypeData structure. The fields pGroupName, pDescription, pContacts, and pContacts.pName should be preallocated by the user with their respective maximum sizes. Call db2GetContactGroup with numContacts=0 and pContacts=NULL to have the required length for pContacts returned in numContacts.

db2ContactTypeData data structure parameters

contactType

Specifies the type of contact. Valid values are:

DB2CONTACT_SINGLE
DB2CONTACT_GROUP

pName

The contact group name, or the contact name if contactType is set to DB2CONTACT_SINGLE.

Usage notes

This API is not supported on UNIX and Linux. However, you can access the same functionality through the SQL interface.