Função QueryServiceConfigA (winsvc.h)

Artigo
08/27/2023

Recupera os parâmetros de configuração do serviço especificado. Parâmetros de configuração opcionais estão disponíveis usando a função QueryServiceConfig2 .

Sintaxe

BOOL QueryServiceConfigA(
  [in]            SC_HANDLE               hService,
  [out, optional] LPQUERY_SERVICE_CONFIGA lpServiceConfig,
  [in]            DWORD                   cbBufSize,
  [out]           LPDWORD                 pcbBytesNeeded
);

Parâmetros

[in] hService

Um identificador para o serviço. Esse identificador é retornado pela função OpenService ou CreateService e deve ter o direito de acesso SERVICE_QUERY_CONFIG. Para obter mais informações, consulte Segurança do Serviço e Direitos de Acesso.

[out, optional] lpServiceConfig

Um ponteiro para um buffer que recebe as informações de configuração do serviço. O formato dos dados é uma estrutura QUERY_SERVICE_CONFIG .

O tamanho máximo dessa matriz é de 8K bytes. Para determinar o tamanho necessário, especifique NULL para esse parâmetro e 0 para o parâmetro cbBufSize . A função falhará e GetLastError retornará ERROR_INSUFFICIENT_BUFFER. O parâmetro pcbBytesNeeded receberá o tamanho necessário.

[in] cbBufSize

O tamanho do buffer apontado pelo parâmetro lpServiceConfig , em bytes.

[out] pcbBytesNeeded

Um ponteiro para uma variável que recebe o número de bytes necessários para armazenar todas as informações de configuração, se a função falhar com ERROR_INSUFFICIENT_BUFFER.

Valor retornado

Se a função for bem-sucedida, o valor retornado será diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Os códigos de erro a seguir podem ser definidos pelo gerenciador de controle de serviço. Outras podem ser definidas pelas funções do Registro que são chamadas pelo gerenciador de controle de serviço.

Código de retorno	Descrição
ERROR_ACCESS_DENIED	O identificador não tem o direito de acesso SERVICE_QUERY_CONFIG.
ERROR_INSUFFICIENT_BUFFER	Há mais informações de configuração de serviço que caberiam no buffer lpServiceConfig . O número de bytes necessários para obter todas as informações é retornado no parâmetro pcbBytesNeeded . Nada é gravado em lpServiceConfig.
ERROR_INVALID_HANDLE	O identificador especificado é inválido.

Comentários

A função QueryServiceConfig retorna as informações de configuração de serviço mantidas no registro de um serviço específico. Essas informações de configuração são definidas primeiro por um programa de controle de serviço usando a função CreateService . Essas informações podem ter sido atualizadas por um programa de configuração de serviço usando a função ChangeServiceConfig .

Se o serviço estava em execução quando as informações de configuração foram alteradas pela última vez, as informações retornadas por QueryServiceConfig não refletirão a configuração atual do serviço. Em vez disso, ele refletirá a configuração do serviço quando ele for executado na próxima execução. A chave DisplayName é uma exceção a isso. Quando a chave DisplayName é alterada, ela entra em vigor imediatamente, independentemente de o serviço ser executado.

Exemplos

Para obter um exemplo, consulte Consultando a configuração de um serviço.

Observação

O cabeçalho winsvc.h define QueryServiceConfig como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winsvc.h (incluir Windows.h)
Biblioteca	Advapi32.lib
DLL	Advapi32.dll