DB2 Version 10.1 for Linux, UNIX, and Windows

db2UpdateContact API - Update the attributes of a contact

Updates the attributes of a contact. 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

Instance. If there is no instance attachment, a default instance attachment is created.

API include file

db2ApiDf.h

API and data structure syntax

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

typedef SQL_STRUCTURE db2UpdateContactData
{
   char *piUserid;
   char *piPassword;
   char *piContactName;
   db2Uint32 iNumAttribsUpdated;
   struct db2ContactAttrib *piAttribs;
} db2UpdateContactData;

typedef SQL_STRUCTURE db2ContactAttrib
{
   db2Uint32 iAttribID;
   char *piAttribValue;
} db2ContactAttrib;

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

db2UpdateContactData data structure parameters

piContactName: Input. Specifies the name of the contact to be updated.
iNumAttribsUpdated: Input. The number attributes to be updated.
piAttribs: Input. A pointer to the db2ContactAttrib structure.

db2ContactAttrib data structure parameters

iAttribID

Input. Specifies the contact attribute. Valid values are:

DB2CONTACT_ADDRESS
DB2CONTACT_TYPE
DB2CONTACT_MAXPAGELEN
DB2CONTACT_DESCRIPTION

piAttribValue

Input. The new value of the contact attribute.

Usage notes

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