Llamadas a función de la API

Editar en línea

La Tabla 1 proporciona una lista alfabética de las llamadas de función de API, una breve descripción y la ubicación de información más detallada sobre la llamada de función, que incluye:
Elemento Descripción
Finalidad Describe la llamada de función.
Sintaxis Contiene el código C real de la llamada de función. Este código se copia desde la versión de UNIX o Linux® del archivo de cabecera dsmapifp.h . Consulte Archivo de origen de definiciones de función de API.

Este archivo cambia ligeramente en otros sistemas operativos. Los programadores de aplicación de otros sistemas operativos deben comprobar su versión del archivo de encabezado, dsmapifp.h, para obtener la sintaxis exacta de las definiciones de la API.
Parámetros Describe cada uno de los parámetros en la llamada de función, identificándola como una entrada (I) o salida (O), dependiendo de cómo se utilice. Algunos parámetros están diseñados para funcionar tanto de entrada como de salida (I/O). Los tipos de datos que se mencionan en esta sección se definen en el archivo de encabezado dsmapitd.h. Consulte Archivos de origen de definiciones de tipo de API.
Códigos de retorno Contiene una lista de los códigos de retorno que son específicos a la llamada de función. Los errores del sistema generales, como los errores de comunicación, problemas del servidor o errores del usuario que puedan aparecen en una llamada no se incluyen en la lista. Los códigos de retorno se definen en el archivo de encabezado dsmrc.h. Consulte Archivo de origen de códigos de retorno de API: dsmrc.h.
Tabla 1. Llamadas a función de la API
Llamada a función y enlace Descripción
dsmBeginGetData Inicia una operación de restauración o recuperación en una lista de objetos del almacenamiento.
dsmBeginQuery Inicia una solicitud de consulta a IBM® Storage Protect para obtener información.
dsmBeginTxn Inicia una o más transacciones que empiezan una acción completa. O bien todas las acciones tienen éxito o ninguna.
dsmBindMC Asocia o vincula una clase de gestión al objeto que pasa.
dsmChangePW Cambia una contraseña de IBM Storage Protect .
dsmCleanUp Esta llamada se utiliza si se ha llamado a dsmSetUp.
dsmDeleteAccess Elimina las reglas de autorización de las copias de seguridad o archivadas de los objetos.
dsmDeleteFS Elimina un espacio de archivo del almacenamiento.
dsmDeleteObj Desactiva copias de seguridad, o elimina copias archivadas del almacenamiento.
dsmEndGetData Finaliza una sesión de dsmBeginGetData que obtiene objetos del almacenamiento.
dsmEndGetDataEx Proporciona el total de bytes sin LAN que fueron enviados.
dsmEndGetObj Finaliza una sesión de dsmGetObj que obtiene datos para un objeto especificado.
dsmEndQuery Indica el final de una acción de dsmBeginQuery .
dsmEndSendObj Indica el final de los datos que se envían al almacenamiento.
dsmEndSendObjEx Proporciona información de compresión y el número de bytes que se enviaron.
dsmEndTxn Finaliza una transacción de IBM Storage Protect .
dsmEndTxnEx Proporciona información acerca del ID del objeto líder que se utiliza en la llamada dsmGroupHandlerfunction.
dsmGetData Obtiene una secuencia de bytes de datos de IBM Storage Protect y la coloca en el almacenamiento intermedio del llamante.
dsmGetBufferData Obtiene un almacenamiento intermedio asignado por IBM Storage Protectde datos del servidor de IBM Storage Protect .
dsmGetNextQObj Obtiene la siguiente respuesta de consulta de una llamada dsmBeginQuery anterior y la coloca en el almacenamiento intermedio del llamante.
dsmGetObj Obtiene los datos del objeto solicitados de la corriente de datos y los coloca en el almacenamiento intermedio del llamador.
dsmGroupHandler Realiza una acción en un grupo de archivos lógico dependiendo de la entrada dada.
dsmInit Inicia una sesión de la API y conecta al cliente con el almacenamiento.
dsmInitEx Inicia una sesión de la API utilizando parámetros adicionales que permiten la verificación extendida.
dsmLogEvent Registra un mensaje de usuario al archivo de registros del servidor, al registro de error local o a ambos.
dsmLogEventEx Registra un mensaje de usuario al archivo de registros del servidor, al registro de error local o a ambos.
dsmQueryAccess Realiza una consulta al servidor acerca de todas las reglas de autorización de acceso en versiones de copias archivadas o de copias de seguridad de objetos.
dsmQueryApiVersion Realiza una solicitud de consulta acerca de la versión de la biblioteca de la API a la que accede el cliente de la aplicación.
dsmQueryApiVersionEx Realiza una solicitud de consulta acerca de la versión de la biblioteca de la API a la que accede el cliente de la aplicación.
dsmQueryCliOptions Consulta valores de opción importantes en los archivos de opción del usuario.
dsmQuerySessInfo Inicia una solicitud de consulta a IBM Storage Protect para obtener información relacionada con el funcionamiento de la sesión especificada en dsmHandle.
dsmQuerySessOptions Consulta valores de opción importantes que son válidos en la sesión especificada en dsmHandle.
dsmRCMsg Obtiene el texto del mensaje que está asociado con el código de retorno de la API.
dsmRegisterFS Registra un espacio de archivo nuevo con el servidor.
dsmReleaseBuffer Devuelve un almacenamiento intermedio asignado por IBM Storage Protect.
dsmRenameObj Renombra el alto y bajo rango del objeto.
dsmRequestBuffer Obtiene un almacenamiento intermedio asignado por IBM Storage Protectpara la eliminación de copia de almacenamiento intermedio.
dsmRetentionEvent Envía una lista de ID de objetos al servidor, con una operación de evento de retención para que se realice en estos objetos.
dsmSendBufferData Envía datos desde un almacenamiento intermedio asignado por IBM Storage Protect.
dsmSendData Envía una secuencia de bytes de datos a IBM Storage Protect a través de un almacenamiento intermedio.
dsmSendObj Inicia una solicitud para enviar un objeto único al almacenamiento.
dsmSetAccess Da a otros usuarios o nodos acceso a versiones de copia de seguridad o copias archivadas de los objetos, acceso a todos los objetos o acceso a un grupo determinado.
dsmSetUp Sobrescribe los valores de variable de entorno.
dsmTerminate Finaliza una sesión con el servidor y limpia el entorno de IBM Storage Protect .
dsmUpdateFS Actualiza un espacio de archivo en el almacenamiento.
dsmUpdateObj Actualiza la información objInfo que está asociada con una copia de seguridad activa de un objeto que ya está en el servidor, o actualiza objetos archivados.
dsmUpdateObjEx Actualiza la información objInfo que está asociada con un objeto archivado específico incluso cuando existen varios objetos con el mismo nombre, o actualiza copias de seguridad activas.