Função AddConsoleAlias
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.
Define um alias de console para o executável especificado.
Sintaxe
BOOL WINAPI AddConsoleAlias(
_In_ LPCTSTR Source,
_In_ LPCTSTR Target,
_In_ LPCTSTR ExeName
);
Parâmetros
Origem [in]
O alias do console a ser mapeado para o texto especificado por Destino.
Destino [in]
O texto a ser substituído por Fonte. Se esse parâmetro é NULL, o alias do console é removido.
ExeName [in]
O nome do arquivo executável para o qual o alias do console deve ser definido.
Valor retornado
Se a função obtiver êxito, o valor retornado será TRUE.
Se a função falhar, o valor retornado será FALSE. Para obter informações de erro estendidas, chame GetLastError.
Comentários
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.
Exemplos
Para ver um exemplo, confira Aliases de console.
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 | AddConsoleAliasW (Unicode) e AddConsoleAliasA (ANSI) |