Syntax

    LONG CDI_Object_Update (
       LONG                      cdmOSHandle,
       LONG                      cdiBindHandle,
       struct UpdateInfoStruct  *info,
       LONG                      infoSize,
       LONG                      reasonFlag
       );
    
    

Parameters

cdmOSHandle

(IN) The CDM's handle for using the CDI APIs. The value of cdmOSHandle was assigned during CDI_Register_CDM, and it is used in conjunction with the CDM-generated CDMHandle to uniquely identify a CDM when it interfaces with NWPA through the CDI API set.

cdiBindHandle

(IN) NWPA-generated bind handle that was assigned to the calling CDM when it bound to the target device using CDI_Bind_CDM_To_Object.

info

(IN) Points to an UpdateInfoStruct. This structure contains the information telling NWPA what items will be updated for the target device.

infoSize

(IN) The size of the UpdateInfoStruct pointed at by info.

reasonFlag

(IN) An NWPA code corresponding to the reason why the update is being done. The following is a list of valid codes that may be placed in this field:

Return Values

The following table lists return values and descriptions.

Remarks

CDI_Object_Update is used by a CDM to update device object information with NWPA. Typically, object updating is done when the CDM needs to deactivate a device or put in capacity, unit size, or block size information for a removable device on a mount.

Although it is not a specific NWPA requirement, it is good practice for a CDM to store the device object information for each device it supports into a local structure.

Whenever device information is updated, the update information should also be mirrored into the local storage structure. Doing this allows the CDM to know the current operational information for each device it supports. However, to save NWPA time and overhead in performing the update, the CDM should allocate a reusable UpdateInfoStruct to use exclusively as an input parameter to CDI_Object_Update. Then, when an update is necessary, the CDM should do the following: