sapi_windows_vt100_support
(PHP 7 >= 7.2.0)
sapi_windows_vt100_support — Get or set VT100 support for the specified stream associated to an output buffer of a Windows console.
Description
$stream
[, bool $enable
] ) : bool
If enable is omitted, the function returns TRUE if the stream stream has VT100 control codes enabled, FALSE otherwise.
If enable is specified, the function will try to enable or disable the VT100 features of the stream stream.
If the feature has been successfully enabled (or disabled), the function will return TRUE, or FALSE otherwise.
At startup, PHP tries to enable the VT100 feature of the STDOUT/STDERR streams. By the way, if those streams are redirected to a file, the VT100 features may not be enabled.
If VT100 support is enabled, it is possible to use control sequences as they are known from the VT100 terminal. They allow the modification of the terminal's output. On Windows these sequences are called Console Virtual Terminal Sequences.
This function uses the ENABLE_VIRTUAL_TERMINAL_PROCESSING flag implemented in the Windows 10 API, so the VT100 feature may not be available on older Windows versions.
Liste de paramètres
-
stream -
The stream on which the function will operate.
-
enable -
If specified, the VT100 feature will be enabled (if
TRUE) or disabled (ifFALSE).
Valeurs de retour
If enable is not specified: returns TRUE if the VT100 feature is enabled, FALSE otherwise.
If enable is specified: Cette fonction retourne TRUE en cas de succès ou FALSE si une erreur survient.
Exemples
Exemple #1 sapi_windows_vt100_support() default state
By default, STDOUT and STDERR have the VT100 feature enabled.
php -r "var_export(sapi_windows_vt100_support(STDOUT));echo ' ';var_export(sapi_windows_vt100_support(STDERR));"
L'exemple ci-dessus va afficher quelque chose de similaire à :
true true
By the way, if a stream is redirected, the VT100 feature will not be enabled:
php -r "var_export(sapi_windows_vt100_support(STDOUT));echo ' ';var_export(sapi_windows_vt100_support(STDERR));" 2>NUL
L'exemple ci-dessus va afficher quelque chose de similaire à :
true false
Exemple #2 sapi_windows_vt100_support() changing state
You won't be able to enable the VT100 feature of STDOUT or STDERR if the stream is redirected.
php -r "var_export(sapi_windows_vt100_support(STDOUT, true));echo ' ';var_export(sapi_windows_vt100_support(STDERR, true));" 2>NUL
L'exemple ci-dessus va afficher quelque chose de similaire à :
true false
Exemple #3 Example usage of VT100 support enabled
<?php
$out = fopen('php://stdout','w');
fwrite($out, 'Just forgot a lettr.');
// Moves the cursor two characters backwards
fwrite($out, "\033[2D");
// Inserts one blank, shifting existing text to the right -> Just forgot a lett r.
fwrite($out, "\033[1@");
fwrite($out, 'e');
?>
L'exemple ci-dessus va afficher :
Just forgot a letter.
Version en cache
25/11/2024 13:22:47 Cette version de la page est en cache (à la date du 25/11/2024 13:22:47) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 30/01/2003, dernière modification le 26/10/2018
Source du document imprimé : https://www.gaudry.be/php-rf-sapi-windows-vt100-support.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.
