Função GetConsoleAliases
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 todos os aliases do console definidos para o executável especificado.
Sintaxe
DWORD WINAPI GetConsoleAliases(
_Out_ LPTSTR lpAliasBuffer,
_In_ DWORD AliasBufferLength,
_In_ LPTSTR lpExeName
);
Parâmetros
lpAliasBuffer [out]
Um ponteiro para um buffer que recebe os aliases.
O formato dos dados é o seguinte: Source1=Target1\0Source2=Target2\0... SourceN=TargetN\0, onde N é o número de aliases do console definidos.
AliasBufferLength [in]
O tamanho, em bytes, do buffer apontado por lpAliasBuffer.
lpExeName [in]
O arquivo executável cujos aliases devem ser recuperados.
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 lpExeName, use a função GetConsoleAliasesLength.
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 | GetConsoleAliasesW (Unicode) e GetConsoleAliasesA (ANSI) |