DB2 Version 10.1 for Linux, UNIX, and Windows

db2UpdateContactGroup API - Update the attributes of a contact group

Updates the attributes of a contact group. A contact group contains a list of 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.

Authorization

None.

Required connection

None.

API include file

db2ApiDf.h

API and data structure syntax

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

typedef SQL_STRUCTURE db2UpdateContactGroupData
{
   char *piUserid;
   char *piPassword;
   char *piGroupName;
   db2Uint32 iNumNewContacts;
   struct db2ContactTypeData *piNewContacts;
   db2Uint32 iNumDroppedContacts;
   struct db2ContactTypeData *piDroppedContacts;
   char *piNewDescription;
} db2UpdateContactGroupData;

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

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

db2UpdateContactGroupData data structure parameters

piUserid: Input. The user name.
piPassword: Input. The password for piUserid.
piGroupName: Input. The name of the contact group to update.
iNumNewContacts: Input. The number of new contacts to be added to the group
piNewContacts: Input. A pointer to the db2ContactTypeData structure.
iNumDroppedContacts: Input. The number of contacts in the group to be dropped.
piDroppedContacts: Input. A pointer to the db2ContactTypeData structure.
piNewDescription: Input. The new description for the group. Set this parameter to NULL if the old description should not be changed.

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.