Função GetServiceDisplayNameA (winsvc.h)

Recupera o nome de exibição do serviço especificado.

Sintaxe

BOOL GetServiceDisplayNameA(
  [in]            SC_HANDLE hSCManager,
  [in]            LPCSTR    lpServiceName,
  [out, optional] LPSTR     lpDisplayName,
  [in, out]       LPDWORD   lpcchBuffer
);

Parâmetros

[in] hSCManager

Um identificador para o banco de dados do gerenciador de controle de serviço, conforme retornado pela função OpenSCManager.

[in] lpServiceName

O nome do serviço. Esse nome é o mesmo que o nome da chave do registro do serviço. É melhor escolher um nome com menos de 256 caracteres.

[out, optional] lpDisplayName

Um ponteiro para um buffer que recebe o nome de exibição do serviço. Se a função falhar, esse buffer conterá uma cadeia de caracteres vazia.

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

Esse parâmetro pode especificar uma cadeia de caracteres localizada usando o seguinte formato:

@[caminho]dllname,-strID

A cadeia de caracteres com identificador strID é carregada de dllname; o caminho é opcional. Para obter mais informações, consulte RegLoadMUIString.

Windows Server 2003 e Windows XP: não há suporte para cadeias de caracteres localizadas até o Windows Vista.

[in, out] lpcchBuffer

Um ponteiro para uma variável que especifica o tamanho do buffer apontado por lpDisplayName, em TCHARs.

Na saída, essa variável recebe o tamanho do nome de exibição do serviço, em caracteres, excluindo o caractere de terminação nula.

Se o buffer apontado por lpDisplayName for muito pequeno para conter o nome de exibição, a função não o armazenará. Quando a função retorna, lpcchBuffer contém o tamanho do nome de exibição do serviço, excluindo o caractere de terminação nula.

Valor de retorno

Se as funções forem bem-sucedidas, o valor retornado não será zero.

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

Observações

Há dois nomes para um serviço: o nome do serviço e o nome de exibição. O nome do serviço é o nome da chave do serviço no registro. O nome de exibição é um nome amigável que aparece no aplicativo do painel de controle serviços e é usado com o comando NET START. Para mapear o nome do serviço para o nome de exibição, use a função GetServiceDisplayName. Para mapear o nome de exibição para o nome do serviço, use a função GetServiceKeyName.

Nota

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

Requisitos

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

Consulte também

funções de serviço deOpenSCManager do GetServiceKeyName