Funzione GetConsoleAlias

  • Articolo

Importante

Questo documento descrive le funzionalità della piattaforma della console che non fanno più parte della roadmap dell'ecosistema. Non è consigliabile usare questo contenuto nei nuovi prodotti, ma continueremo a supportare gli utilizzi esistenti per il futuro indefinito. La soluzione moderna preferita è incentrata sulle sequenze di terminale virtuale per garantire la massima compatibilità negli scenari multipiattaforma. Per altre informazioni su questa decisione di progettazione, vedere il documento relativo alla console classica e al terminale virtuale.

Recupera il testo per l'alias della console e il file eseguibile specificati.

Sintassi

DWORD WINAPI GetConsoleAlias(
  _In_  LPTSTR lpSource,
  _Out_ LPTSTR lpTargetBuffer,
  _In_  DWORD  TargetBufferLength,
  _In_  LPTSTR lpExeName
);

Parametri

lpSource [in]
Alias della console di cui recuperare il testo.

lpTargetBuffer [out]
Puntatore a un buffer che riceve il testo associato all'alias della console.

TargetBufferLength [in]
Dimensioni del buffer a cui punta lpTargetBuffer, in byte.

lpExeName [in]
Nome del file eseguibile.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è diverso da zero.

Se la funzione ha esito negativo, il valore restituito è zero. Per informazioni dettagliate sull'errore, chiamare GetLastError.

Osservazioni:

Per compilare un'applicazione che usa questa funzione, definire _WIN32_WINNT come 0x0501 o versione successiva. Per altre informazioni, vedere Uso delle intestazioni di Windows.

Suggerimento

Questa API non è consigliata e non ha un terminale virtuale equivalente. Questa decisione allinea intenzionalmente la piattaforma Windows ad altri sistemi operativi in cui l'applicazione client singola che funge da shell o interprete deve mantenere le proprie funzionalità di praticità utente, ad esempio la lettura e il comportamento di manipolazione delle righe, inclusi alias e cronologia dei comandi. Le applicazioni remote tramite utilità multipiattaforma e trasporti come SSH potrebbero non funzionare come previsto se si usa questa API.

Requisiti

   
Client minimo supportato Windows 2000 Professional [solo app desktop]
Server minimo supportato Windows 2000 Server [solo app desktop]
Intestazione ConsoleApi3.h (tramite WinCon.h, includere Windows.h)
Libreria Kernel32.lib
DLL Kernel32.dll
Nomi Unicode e ANSI GetConsoleAliasW (Unicode) e GetConsoleAliasA (ANSI)

Vedi anche

Alias di console

Funzioni della console

AddConsoleAlias

GetConsoleAliases

GetConsoleAliasExes