Tivoli Storage Manager Using the Application Program Interface

dsmUpdateObj

The dsmUpdateObj function call updates the meta information associated with an active backup or archive object already on the server. The application bit data will not be affected. To update an object, you must give a specific non-wildcard name. To update an archived object, set the dsmSendType to stArchive. Only the latest named archive object is updated.

Note:

The server must be at 3.1.2.1 or a higher level.

You can only start the dsmUpdateObj call in the session state; it cannot be called inside a transaction because it performs its own transaction. And, you can update only one object at a time.

Note:

On a UNIX operating system, if you change the owner field, you will not be able to query or restore the object unless you are the root user.

Syntax

dsInt16_t  dsmUpdateObj
   (dsUint32_t        dsmHandle,
    dsmSendType     sendType,
    void           *sendBuff,
    dsmObjName     *objNameP,
    ObjAttr        *objAttrPtr,    /* objInfo */
    dsUint16_t        objUpdAct);    /* action bit vector */

Parameters

The field descriptions are the same as those in dsmSendObj, with the following exceptions:

dsmObjName *objNameP (I)

You cannot use a wildcard.

ObjAttr *objAttrPtr (I)

The objCompressed field is ignored for this call.

Other differences are:

• owner. If you specify a new owner field, the owner will change.
• sizeEstimate. If you specify a non-zero value, we will expect this to be the actual amount of data sent, in bytes. The value will be stored in the TSM meta data for future use.
• objInfo. This attribute contains the new information to be placed in the objInfo field. Set the objInfoLength to the length of the new objInfo.

dsUint16_t objUpdAct

The bit masks and possible actions for objUpdAct are:

DSM_BACKUPD_MC

Updates the management class for the object.

DSM_BACKUPD_OBJINFO

Updates objInfo, objInfoLength, and sizeEstimate.

DSM_BACKUPD_OWNER

Updates the owner of the object.

DSM_ARCHUPD_DESCR

Updates the Description field. Enter the value for the new description through the SendBuff parameter. See the sample program for proper use.

DSM_ARCHUPD_OBJINFO

Updates objInfo, objInfoLength, and sizeEstimate.

DSM_ARCHUPD_OWNER

Updates the owner of the object.

Return Codes

The return code numbers are provided in parentheses ( ).

Table 46. Return Codes for dsmUpdateObj