dsmBeginGetData

La llamada de función dsmBeginGetData inicia una operación de restauración o recuperación en una lista de objetos en el almacenamiento. La lista de objetos se encuentra dentro de la estructura dsmGetList . La aplicación crea esta lista con valores de la consulta que precedieron a una llamada a dsmBeginGetData.

El llamador debe en primer lugar utilizar los campos del orden de restauración que se obtienen de la consulta del objeto con el fin de ordenar la lista que se incluye en esta llamada. Esto garantiza que los objetos se restauran del almacenamiento de la forma más eficaz posible sin tener que rebobinar o remontar las cintas de datos.

Al obtener objetos enteros, el dsmGetList.numObjID máximo es DSM_MAX_GET_OBJ. Al obtener objetos parciales, el máximo es DSM_MAX_PARTIAL_GET_OBJ.

Siga la llamada a dsmBeginGetData con una o más llamadas a dsmGetObj para obtener cada objeto de la lista. Después de obtener cada objeto, o de que no se necesiten datos adicionales para el objeto, se envía la llamada dsmEndGetObj .

Cuando se obtienen todos los objetos o se cancela dsmEndGetObj , se envía la llamada dsmEndGetData . A continuación puede iniciar el ciclo de nuevo.

Sintaxis

dsInt16_t dsmBeginGetData (dsUint32_t       dsmHandle,
   dsBool_t     mountWait,
   dsmGetType   getType,
   dsmGetList  *dsmGetObjListP);

Parámetros

dsUint32_t dsmHandle (I)
El manejador que asocia esta llamada con una llamada dsmInitEx anterior.
dsBool_t mountWait (I)
Un valor booleano verdadero o falso indica si el cliente de la aplicación espera que se monten medios desconectados si los datos que se necesitan están actualmente desconectados. Si mountWait es verdadero, la aplicación espera a que el servidor monte los medios necesarios. La aplicación espera hasta que el soporte esté montado o la solicitud cancelada.
dsmGetType getType (I)
Un tipo enumerado que consiste en gtBackup y gtArchive indica qué tipo de objeto se va a obtener.
dsmGetList *dsmGetObjListP (I)
Esta estructura contiene información acerca de los objetos o bien de los objetos parciales que se van a restaurar o recuperar. La estructura apunta a una lista de ID de objetos y, en el caso de una recuperación o restauración parcial, a una lista de desplazamientos y longitudes asociadas. Si la aplicación utiliza la función de recuperación o restauración parcial de objetos, configure el campo dsmGetList.stVersion en dsmGetListPORVersion. En una restauración o recuperación de objeto parcial, no es posible comprimir datos mientras los envía. Para implementar esto, configure ObjAttr.objCompressed en bTrue.

Consulte la Figura 1 y los archivos de origen de definiciones de tipo de API para obtener más información sobre esta estructura.

Consulte Restauración o recuperación parcial de objetos para obtener más información sobre la restauración o recuperación parcial de objetos.

Códigos de retorno

Los números de código de retorno se proporcionan entre paréntesis ( ).

Tabla 1. Códigos de retorno para dsmBeginGetData
Código de retorno Explicación
DSM_RC_ABORT_INVALID_OFFSET (33) El desplazamiento especificado durante la recuperación de un objeto parcial es mayor que la longitud del objeto.
DSM_RC_ABORT_INVALID_LENGTH (34) La longitud que se especificó durante la recuperación de un objeto parcial es mayor que la longitud del objeto, o el desplazamiento y la longitud se extienden más allá del final del objeto.
DSM_RC_NO_MEMORY (102) No queda RAM para finalizar la solicitud.
DSM_RC_NUMOBJ_EXCEED (2029) dsmGetList.numObjId es mayor que DSM_MAX_GET_OBJ.
DSM_RC_OBJID_NOTFOUND (2063) No se ha encontrado el ID del objeto. No se restauró el objeto.
DSM_RC_WRONG_VERSION_PARM (2065) La versión de API del cliente de aplicaciones es diferente de la versión de biblioteca de IBM® Storage Protect .