Função ClusterRegBatchAddCommand (clusapi.h)

Adiciona um comando a um lote que será executado em uma chave do Registro de cluster. Chamadas adicionais para a função produzirão comandos adicionais adicionados ao lote. O lote foi criado pela função ClusterRegCreateBatch e será executado ou ignorado pela função ClusterRegCloseBatch .

Sintaxe

LONG ClusterRegBatchAddCommand(
  [in]           HREGBATCH           hRegBatch,
  [in]           CLUSTER_REG_COMMAND dwCommand,
  [in, optional] LPCWSTR             wzName,
  [in]           DWORD               dwOptions,
  [in, optional] VOID const          *lpData,
  [in]           DWORD               cbData
);

Parâmetros

[in] hRegBatch

O identificador do lote ao qual um comando será adicionado.

[in] dwCommand

Um comando compatível com essa API que é obtido da enumeração CLUSTER_REG_COMMAND . Os comandos possíveis são os seguintes.

CLUSREG_SET_VALUE (1)

Define um valor relativo ao último comando CLUSREG_CREATE_KEY executado ou (se não for fornecido) em relação a uma chave passada para a função ClusterRegCreateBatch .

CLUSREG_CREATE_KEY (2)

Cria uma chave do Registro de cluster especificada se ela não existir ou abre uma existente.

CLUSREG_DELETE_KEY (3)

Exclui uma chave com todos os valores e subchaves aninhadas. Nenhum comando que opere em valores pode seguir CLUSREG_DELETE_KEY até que CLUSREG_CREATE_KEY seja adicionado.

CLUSREG_DELETE_VALUE (4)

Exclui um valor relativo ao último comando CLUSREG_CREATE_KEY executado ou (se não fornecido) em relação a uma chave passada para a função ClusterRegCreateBatch .

[in, optional] wzName

O nome do valor ou da chave em relação ao comando emitido pelo parâmetro dwCommand .

[in] dwOptions

Se dwCommand usar o comando CLUSREG_SET_VALUE , esse parâmetro usará um dos tipos de valor padrão do Registro. Caso contrário, dwCommand será definido como 0.

[in, optional] lpData

Um ponteiro para os dados relativos ao comando emitido por dwCommand. O valor desse parâmetro é NULL para todos, exceto o comando CLUSREG_SET_VALUE .

[in] cbData

A contagem, em bytes, dos dados relativos ao comando emitido por dwCommand. O valor desse parâmetro é 0 para todos, exceto o comando CLUSREG_SET_VALUE .

Retornar valor

A função retorna um dos seguintes códigos de erro do sistema.

Valor/código retornado Descrição
ERROR_SUCCESS
0
 A operação foi bem-sucedida.
ERROR_INVALID_FUNCTION
1
 Função incorreta. Esse valor será retornado se dwCommand usar qualquer comando diferente dos comandos descritos na seção anterior.
ERROR_INVALID_HANDLE
6
 O identificador não é válido. Esse valor será retornado se o parâmetro hRegBatch for NULL.
ERROR_OUTOFMEMORY
14 (0xE)
 Não há armazenamento suficiente disponível para concluir esta operação.
ERROR_GEN_FAILURE
31 (0x1F)
 Um dispositivo conectado ao sistema não está funcionando.
ERROR_INVALID_PARAMETER
87 (0x57)
 O parâmetro está incorreto. Esse valor será retornado se a chave do Registro do cluster na qual o lote está tentando executar comandos não for a chave atual.

Comentários

O tipo PCLUSTER_REG_BATCH_ADD_COMMAND define um ponteiro para essa função.

Requisitos

Requisito Valor
Cliente mínimo com suporte Nenhum compatível
Servidor mínimo com suporte Windows Server 2008 Datacenter, Windows Server 2008 Enterprise
Plataforma de Destino Windows
Cabeçalho clusapi.h
Biblioteca ClusAPI.lib
DLL ClusAPI.dll

Confira também

CLUSTER_REG_COMMAND

Funções de acesso ao Registro de Cluster

ClusterRegCloseBatch

ClusterRegCreateBatch

Tipos de valor do Registro

  • Last updated on