Función ClusterRegBatchAddCommand (clusapi.h)

Artículo
08/22/2023

Agrega un comando a un lote que se ejecutará en una clave del Registro del clúster. Las llamadas adicionales a la función producirán comandos adicionales agregados al lote. La función ClusterRegCreateBatch creó el lote y la función ClusterRegCloseBatch la ejecutará o omitirá.

Sintaxis

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

Identificador del lote al que se agregará un comando.

[in] dwCommand

Un comando admitido por esta API que se toma de la enumeración CLUSTER_REG_COMMAND . Los comandos posibles son los siguientes.

CLUSREG_SET_VALUE (1)

Establece un valor relativo al último comando ejecutado CLUSREG_CREATE_KEY o (si no se proporciona) con relación a una clave pasada a la función ClusterRegCreateBatch .

CLUSREG_CREATE_KEY (2)

Crea una clave del Registro de clúster especificada si no existe o abre una existente.

CLUSREG_DELETE_KEY (3)

Elimina una clave con todos los valores y subclaves anidadas. Ningún comando que funcione con valores puede seguir CLUSREG_DELETE_KEY hasta que se agregue CLUSREG_CREATE_KEY .

CLUSREG_DELETE_VALUE (4)

Elimina un valor relativo al último comando ejecutado CLUSREG_CREATE_KEY o (si no se proporciona) con relación a una clave pasada a la función ClusterRegCreateBatch .

[in, optional] wzName

Nombre del valor o clave relativo al comando emitido por el parámetro dwCommand .

[in] dwOptions

Si dwCommand toma el comando CLUSREG_SET_VALUE , este parámetro toma uno de los tipos de valor del Registro estándar. Si no es así, dwCommand se establece en 0.

[in, optional] lpData

Puntero a los datos relativos al comando emitido por dwCommand. El valor de este parámetro es NULL para todos, excepto el comando CLUSREG_SET_VALUE .

[in] cbData

Recuento, en bytes, de los datos relativos al comando emitido por dwCommand. El valor de este parámetro es 0 para todos los CLUSREG_SET_VALUE comando.

Valor devuelto

La función devuelve uno de los siguientes códigos de error del sistema.

Código o valor devuelto	Descripción
ERROR_SUCCESS 0	La operación se realizó correctamente.
ERROR_INVALID_FUNCTION 1	Función incorrecta. Este valor se devuelve si dwCommand toma cualquier comando distinto de los comandos descritos en la sección anterior.
ERROR_INVALID_HANDLE 6	El identificador no es válido. Este valor se devuelve si el parámetro hRegBatch es NULL.
ERROR_OUTOFMEMORY 14 (0xE)	No hay suficiente almacenamiento disponible para completar esta operación.
ERROR_GEN_FAILURE 31 (0x1F)	Uno de los dispositivos conectados al sistema no funciona.
ERROR_INVALID_PARAMETER 87 (0x57)	El parámetro no es correcto. Este valor se devolverá si la clave del Registro del clúster en la que el lote intenta ejecutar comandos no es la clave actual.

Comentarios

El tipo PCLUSTER_REG_BATCH_ADD_COMMAND define un puntero a esta función.

Requisitos

Requisito	Value
Cliente mínimo compatible	No se admite ninguno
Servidor mínimo compatible	Windows Server 2008 Datacenter, Windows Server 2008 Enterprise
Plataforma de destino	Windows
Encabezado	clusapi.h
Library	ClusAPI.lib
Archivo DLL	ClusAPI.dll