Compartilhar via


Função GetConsoleAliasExes

Importante

Este documento descreve a funcionalidade da plataforma de console que não faz mais parte do nosso roteiro do ecossistema. Não recomendamos o uso desse conteúdo em novos produtos, mas continuaremos a oferecer suporte aos usos existentes por tempo indeterminado. Nossa solução moderna preferida se concentra em sequências de terminais virtuais para máxima compatibilidade em cenários de multiplataforma. Você pode encontrar mais informações sobre essa decisão de design em nosso documento Console clássico versus terminal virtual.

Recupera os nomes de todos os arquivos executáveis com aliases de console definidos.

Sintaxe

DWORD WINAPI GetConsoleAliasExes(
  _Out_ LPTSTR lpExeNameBuffer,
  _In_  DWORD  ExeNameBufferLength
);

Parâmetros

lpExeNameBuffer [out]
Um ponteiro para um buffer que recebe os nomes dos arquivos executáveis.

ExeNameBufferLength [in]
O tamanho do buffer apontado por lpExeNameBuffer, em bytes.

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.

Comentários

Para determinar o tamanho necessário do buffer lpExeNameBuffer, use a função GetConsoleAliasExesLength.

Para compilar aplicativos que usam essa função, defina _WIN32_WINNT como 0x0501 ou posterior. Para obter mais informações, consulte Usar os cabeçalhos do Windows.

Dica

Essa API não é recomendada e não tem um terminal virtual equivalente. Essa decisão alinha intencionalmente a plataforma Windows com outros sistemas operacionais em que o aplicativo cliente individual que atua como shell ou intérprete deve manter sua própria funcionalidade de conveniência do usuário, como leitura de linhas e comportamento de manipulação, incluindo aliases e histórico de comandos. A comunicação remota de aplicativos por meio de utilitários multiplataforma e transportes como SSH pode não funcionar como esperado se essa API é usada.

Requisitos

   
Cliente mínimo com suporte Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Cabeçalho ConsoleApi3.h (via WinCon.h, inclui o Windows.h)
Biblioteca Kernel32.lib
DLL Kernel32.dll
Nomes Unicode e ANSI GetConsoleAliasExesW (Unicode) e GetConsoleAliasExesA (ANSI)

Confira também

AddConsoleAlias

Aliases de console

Funções de Console

GetConsoleAlias

GetConsoleAliasExesLength

GetConsoleAliases