Chamadas de Função da API

Editar on-line

A Tabela 1 fornece uma lista alfabética das chamadas de função API, uma breve descrição e o local de informações mais detalhadas sobre a chamada de função, que inclui:
Elemento descrição
Finalidade Descreve a chamada da função.
Sintaxe Contém o código C em si para a chamada de função. Esse código é copiado da versão UNIX ou Linux® do arquivo de cabeçalho dsmapifp.h . Consulte Arquivo de origem de definições de função da API.

Este arquivo é ligeiramente diferente em outros sistemas operacionais. Os programadores de aplicativos para outros sistemas operacionais devem verificar sua versão do arquivo de cabeçalho dsmapifp.h para obter a sintaxe exata das definições de API.
Parâmetros Descreve cada parâmetro da chamada de função, identificando-o como entrada (E) ou saída (S), dependendo de como é utilizado. Alguns parâmetros são designados como ambos, entrada e saída (E/S). Os tipos de dados que são referidos nesta seção são definidos no arquivo de cabeçalho dsmapitd.h. Consulte Arquivos de Origem de Definições de Tipo de API
Códigos de retorno Contém uma lista dos códigos de retorno que são específicos para a chamada de função. Erros gerais do sistema, como erros de comunicação, problemas de servidor ou erros do usuário, que podem aparecer em qualquer chamada não são listados. Os códigos de retorno são definidos no arquivo de cabeçalho dsmrc.h. Consulte Arquivo de origem de códigos de retorno da API: dsmrc.h.
Tabela 1. Chamadas de Função da API
Chamada de função e link descrição
dsmBeginGetData Inicia uma operação de restauração ou recuperação em uma lista de objetos em armazenamento.
dsmBeginQuery Inicia uma solicitação de consulta para o IBM® Storage Protect para obter informações
dsmBeginTxn Inicia uma ou mais transações que inicial uma ação completa. Todas as ações foram bem-sucedidas ou nenhuma foi bem-sucedida.
dsmBindMC Associa ou liga uma classe de gerenciamento ao objeto que é transmitido.
dsmChangePW Altera uma senha do IBM Storage Protect
dsmCleanUp Esta chamada é usada se dsmSetUp foi chamado.
dsmDeleteAccess Exclui as regras de autorização atuais para versões de backup ou cópias arquivadas de seus objetos.
dsmDeleteFS Exclui um espaço no arquivo do armazenamento.
dsmDeleteObj Desativa objetos de backup ou exclui objetos de archive do armazenamento.
dsmEndGetData Termina uma sessão dsmBeginGetData que obtém objetos de armazenamento.
dsmEndGetDataEx Fornece o total de bytes sem a LAN que foram enviados.
dsmEndGetObj Termina uma sessão dsmGetObj que obtém dados para um objeto especificado.
dsmEndQuery Significa o fim de uma ação dsmBeginQuery .
dsmEndSendObj Indica o final dos dados que são enviados ao armazenamento.
dsmEndSendObjEx Fornece informações de compactação e o número de bytes que foram enviados.
dsmEndTxn Termina uma transação IBM Storage Protect .
dsmEndTxnEx Fornece informações do ID do objeto líder do grupo que serão utilizadas com a chamada de dsmGroupHandlerfunction.
dsmGetData Obtém um fluxo de bytes de dados do IBM Storage Protect e coloca-o no buffer do responsável pela chamada
dsmGetBufferData Obtém um buffer de dados alocado do IBM Storage Protectdo servidor IBM Storage Protect .
dsmGetNextQObj Obtém a próxima resposta de consulta a partir de uma chamada dsmBeginQuery anterior e coloca-a no buffer do chamante.
dsmGetObj Obtém os dados do objeto solicitado do fluxo de dados e coloca-os no buffer do responsável pela chamada.
dsmGroupHandler Executa uma ação em um grupo de arquivos lógico, dependendo da entrada fornecida.
dsmInit Inicia uma sessão de API e conecta o cliente ao armazenamento.
dsmInitEx Inicia uma sessão de API utilizando os parâmetros adicionais que permitem verificação estendida.
dsmLogEvent Registra uma mensagem de usuário no arquivo de log do servidor, no log de erros local ou em ambos.
dsmLogEventEx Registra uma mensagem de usuário no arquivo de log do servidor, no log de erros local ou em ambos.
dsmQueryAccess Consulta no servidor todas as regras de autorização de acesso para versões de backup ou cópias arquivadas de seus objetos.
dsmQueryApiVersion Executa um pedido de consulta à versão da biblioteca de API que o cliente aplicativo acessa.
dsmQueryApiVersionEx Executa um pedido de consulta à versão da biblioteca de API que o cliente aplicativo acessa.
dsmQueryCliOptions Consulta valores de opções importantes nos arquivos de opções do usuário.
dsmQuerySessInfo Inicia uma solicitação de consulta para o IBM Storage Protect para obter informações relacionadas à operação da sessão especificada no dsmHandle.
dsmQuerySessOptions Consulta valores de opções importantes que são válidos na sessão especificada em dsmHandle.
dsmRCMsg Obtém o texto de mensagem associado a um código de retorno de API.
dsmRegisterFS Registra um novo espaço no arquivo no servidor.
dsmReleaseBuffer Retorna um buffer alocado do IBM Storage Protect
dsmRenameObj Renomeia o nome do objeto de nível superior ou de nível inferior.
dsmRequestBuffer Obtém um buffer alocado do IBM Storage Protectpara a eliminação de cópia do buffer
dsmRetentionEvent Envia uma lista de IDs de objetos ao servidor com uma operação de evento de retenção a ser realizada nesses objetos.
dsmSendBufferData Envia dados de um buffer alocado do IBM Storage Protect.
dsmSendData Envia um fluxo de bytes de dados para o IBM Storage Protect via um buffer.
dsmSendObj Inicia um pedido para enviar um único objeto ao armazenamento.
dsmSetAccess Fornece a outros usuários ou nós acesso a versões de backup ou cópias arquivadas de seus objetos, acesso a todos os seus objetos ou acesso a um conjunto seletivo.
dsmSetUp Sobrescreve os valores de variáveis de ambiente.
dsmTerminate Termina uma sessão com o servidor e limpa o ambiente IBM Storage Protect .
dsmUpdateFS Atualiza um espaço no arquivo no armazenamento.
dsmUpdateObj Atualiza as informações de objInfo associadas a um objeto de backup ativo que já se encontra no servidor ou atualizar objetos arquivados.
dsmUpdateObjEx Atualiza as informações de objInfo associadas a um objeto de archive específico mesmo quando há vários objetos com o mesmo nome ou atualiza objetos de backup ativos.