dsmUpdateObjEx

Edit online

The dsmUpdateObjEx function call updates the meta information that is associated with an active backup or archive object that is on the server. The application bit data is not affected. To update an object, you must specify a non-wildcard name, or you can specify the object ID to update a specific archived object. You cannot use wildcard characters when specifying the name. To update a backup object, set the dsmSendType parameter to stBackup. To update an archived object, set the dsmSendType parameter to stArchive.

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

Restriction: On a UNIX or Linux® operating system, if you change the owner field, you cannot query or restore the object unless you are the root user. Only the current active version of a backup object can be updated.

Syntax

dsInt16_t  dsmUpdateObjEx
   (dsmUpdateObjExIn_t   *dsmUpdateObjExInP,
    dsmUpdateObjExOut_t  *dsmUpdateObjExOutP);

Parameters

dsmUpdateObjExIn_t *dsmUpdateObjExInP
This structure contains the following input parameters:
dsUint16_t stVersion (I)
The current version of the structure that is used.
dsUint32_t dsmHandle (I)
The handle that associates this call with a previous dsmInitEx call.
dsmSendType sendType (I)
The type of send that is being performed. The value can be:
stBackup
A backup object that is sent to the server.
stArchive
An archive object that is sent to the server.
dsmObjName *objNameP (I)
A pointer to the structure that contains the filespace name, high-level object name, low-level object name, and object type. You cannot use a wildcard.
ObjAttr *objAttrPtr (I)
Passes object attributes to the application. The values that are updated depend on the flags in the objUpdAct field. The objCompressed attribute is ignored for this call.

The attributes are:

  • owner changes the owner if a new name is entered.
  • sizeEstimate is the actual amount of data that is sent in bytes. The value is stored in the IBM® Storage Protect meta data for future use.
  • objCompressed is a Boolean value that states whether or not the object data have already been compressed.
  • objInfo is an attribute that contains the new information to be placed in the objInfo field. Set the objInfoLength to the length of the new objInfo.
  • mcNameP contains the name of a management class that overrides the management class that is obtained from dsmBindMC.
dsUint32_t objUpdAct
Specifies the bit masks and actions for objUpdAct are:
DSM_BACKUPD_MC
Updates the management class for the object.
DSM_BACKUPD_OBJINFO
Updates the information object (objInfo), the length of the information object (objInfoLength), and the amount of data that is sent (sizeEstimate) for the backup object.
DSM_BACKUPD_OWNER
Updates the owner for the backup object.
DSM_ARCHUPD_DESCR
Updates the Description field for the archive object. Enter the value for the new description through the sendBuff parameter.
DSM_ARCHUPD_OBJINFO
Updates the information object (objInfo), the length of the information object (objInfoLength), and the amount of data that is sent (sizeEstimate) for the archive object.
DSM_ARCHUPD_OWNER
Updates the owner of the archive object.
ObjID archObjId
Specifies the unique object ID for a specific archive object. Because multiple archive objects can have the same name, this parameter identifies a specific one. You can obtain the object ID by using a query archive call.
dsmUpdateObjExOut_t *dsmUpdateObjExOutP
This structure contains the output parameter:
dsUint16_t stVersion (I)
The current version of the structure that is used.

Return codes

The return code numbers are provided in parentheses ( ) in the following table.

Table 1. Return codes for dsmUpdateObjEx
Return code Explanation
DSM_RC_INVALID_ACTION (2012) Invalid action.
DSM_RC_FS_NOT_REGISTERED (2061) File space not registered.
DSM_RC_BAD_CALL_SEQUENCE (2041) Sequence of calls is invalid.
DSM_RC_WILDCHAR_NOTALLOWED (2050) Wildcard characters are not allowed.
DSM_RC_ABORT_NO_MATCH (2) Previous query does not match.