_pipe

Crée un canal pour la lecture et l’écriture.

Important

Cette API ne peut pas être utilisée dans les applications qui s’exécutent dans le Windows Runtime. Pour plus d’informations, consultez Fonctions CRT non prises en charge dans les applications de la plateforme Windows universelle.

Syntaxe

int _pipe(
   int *pfds,
   unsigned int psize,
   int textmode
);

Paramètres

pfds
Pointeur vers un tableau de deux int pour contenir les descripteurs de fichier de lecture et d’écriture.

psize
Quantité de mémoire à réserver.

textmode
Mode de Fichier.

Valeur retournée

Retourne 0 en cas de réussite. Retourne -1 pour indiquer une erreur. En cas d’erreur, errno prend l’une de ces valeurs :

  • EMFILE, qui indique qu’aucun autre descripteur de fichier n’est disponible.

  • ENFILE, qui indique un dépassement de capacité positif de table de fichiers système.

  • EINVAL, qui indique que soit le tableau pfds est un pointeur Null, soit qu’une valeur non valide a été transmise pour textmode.

Pour plus d’informations sur ces codes de retour et d’autres codes de retour, consultez , , _sys_errlist_doserrnoet _sys_nerr.errno

Notes

La fonction _pipe crée un canal, c’est-à-dire un canal d’E/S artificiel qu’un programme utilise pour transmettre des informations à d’autres programmes. Un canal ressemble à un fichier, car il a un pointeur de fichier, un descripteur de fichier, ou les deux. Il peut également être lu ou écrit à l’aide des fonctions d’entrée et de sortie de la bibliothèque standard. Toutefois, un canal ne représente pas un fichier ou un appareil spécifique. En effet, il représente un stockage temporaire en mémoire qui est indépendant de la mémoire propre au programme et qui est contrôlé entièrement par le système d’exploitation.

La fonction _pipe ressemble à _open, sauf qu’elle ouvre le canal à des fins de lecture et d’écriture et retourne deux descripteurs de fichier au lieu d’un seul. Le programme peut utiliser les deux côtés du canal ou fermer celui dont il n’a pas besoin. Par exemple, le processeur de commandes de Windows crée un canal au moment d’exécuter une commande telle que PROGRAM1 | PROGRAM2.

Le descripteur de sortie standard de PROGRAM1 est rattaché au descripteur d’écriture du canal. Le descripteur d’entrée standard de PROGRAM2 est rattaché au descripteur de lecture du canal. Cette pièce jointe élimine la nécessité de créer des fichiers temporaires pour transmettre des informations à d’autres programmes.

La fonction _pipe retourne deux descripteurs de fichier au canal indiqué dans l’argument pfds. L’élément pfds[0] contient le descripteur de lecture, tandis que l’élément pfds[1] contient le descripteur d’écriture. Les descripteurs de fichier de canal sont utilisés de la même façon que les autres descripteurs de fichier. (Les fonctions _read d’entrée et de sortie de bas niveau et _write peuvent lire et écrire dans un canal.) Pour détecter la condition de fin de canal, recherchez une _read requête qui retourne 0 comme nombre d’octets lus.

L’argument psize spécifie la quantité de mémoire, en octets, à réserver pour le canal. L’argument textmode spécifie le mode de traduction pour le canal. La constante _O_TEXT manifeste spécifie une traduction de texte ANSI et la constante _O_BINARY spécifie la traduction binaire. (Voir fopen, _wfopen pour obtenir une description des modes texte et binaire.) Si l’argument textmode est 0, _pipe utilise le mode de traduction par défaut spécifié par la variable _fmodeen mode par défaut.

Dans les programmes multithread, aucun verrouillage n’est effectué. Les descripteurs de fichier retournés sont nouvellement ouverts et ne doivent pas être référencés par un thread tant que l’appel _pipe n’est pas terminé.

Pour utiliser la fonction _pipe en vue d’établir une communication entre un processus parent et un processus enfant, chaque processus doit avoir un seul descripteur ouvert sur le canal. Les descripteurs doivent être contraires : si le parent a un descripteur de lecture ouvert, l’enfant doit avoir un descripteur d’écriture ouvert. Il est plus simple d’utiliser un « ou » au niveau du bit (|) sur l’indicateur _O_NOINHERIT avec textmode. Ensuite, utilisez _dup ou _dup2 pour créer une copie pouvant être héritée du descripteur de canal que vous voulez transmettre à l’enfant. Fermez le descripteur d’origine, puis générez le processus enfant. Une fois le retour de l’appel de génération obtenu, fermez le descripteur en double dans le processus parent. Pour plus d’informations, consultez l’exemple 2 plus loin dans ce même article.

Dans le système d’exploitation Windows, un canal est détruit dès lors que tous ses descripteurs sont fermés. (Si tous les descripteurs de lecture sur le canal ont été fermés, l’écriture dans le canal provoque une erreur.) Toutes les opérations de lecture et d’écriture sur le canal attendent qu’il y ait suffisamment de données ou suffisamment d’espace tampon pour terminer la requête d’E/S.

Par défaut, l’état global de cette fonction est limité à l’application. Pour modifier ce comportement, consultez État global dans le CRT.

Spécifications

Routine En-tête requis En-tête facultatif
_pipe <io.h> <fcntl.h>,1 <errno.h>2

1 Pour _O_BINARY et _O_TEXT définitions.

2 errno définitions.

Pour plus d’informations sur la compatibilité, consultez Compatibility.

Bibliothèques

Toutes les versions des bibliothèques Runtime C.

Exemple 1

// crt_pipe.c
/* This program uses the _pipe function to pass streams of
* text to spawned processes.
*/

#include <stdlib.h>
#include <stdio.h>
#include <io.h>
#include <fcntl.h>
#include <process.h>
#include <math.h>

enum PIPES { READ, WRITE }; /* Constants 0 and 1 for READ and WRITE */
#define NUMPROBLEM 8

int main( int argc, char *argv[] )
{
   int fdpipe[2];
   char hstr[20];
   int pid, problem, c;
   int termstat;

   /* If no arguments, this is the spawning process */
   if( argc == 1 )
   {

      setvbuf( stdout, NULL, _IONBF, 0 );

      /* Open a set of pipes */
      if( _pipe( fdpipe, 256, O_BINARY ) == -1 )
          exit( 1 );

      /* Convert pipe read descriptor to string and pass as argument
       * to spawned program. Program spawns itself (argv[0]).
       */
      _itoa_s( fdpipe[READ], hstr, sizeof(hstr), 10 );
      if( ( pid = _spawnl( P_NOWAIT, argv[0], argv[0],
            hstr, NULL ) ) == -1 )
          printf( "Spawn failed" );

      /* Put problem in write pipe. Since spawned program is
       * running simultaneously, first solutions may be done
       * before last problem is given.
       */
      for( problem = 1000; problem <= NUMPROBLEM * 1000; problem += 1000)
      {

         printf( "Son, what is the square root of %d?\n", problem );
         _write( fdpipe[WRITE], (char *)&problem, sizeof( int ) );

      }

      /* Wait until spawned program is done processing. */
      _cwait( &termstat, pid, WAIT_CHILD );
      if( termstat & 0x0 )
         printf( "Child failed\n" );

      _close( fdpipe[READ] );
      _close( fdpipe[WRITE] );

   }

   /* If there is an argument, this must be the spawned process. */
   else
   {

      /* Convert passed string descriptor to integer descriptor. */
      fdpipe[READ] = atoi( argv[1] );

      /* Read problem from pipe and calculate solution. */
      for( c = 0; c < NUMPROBLEM; c++ )
      {

        _read( fdpipe[READ], (char *)&problem, sizeof( int ) );
        printf( "Dad, the square root of %d is %3.2f.\n",
                 problem, sqrt( ( double )problem ) );

      }
   }
}
Son, what is the square root of 1000?
Son, what is the square root of 2000?
Son, what iDad, the square root of 1000 is 31.62.
Dad, the square root of 2000 is 44.72.
s the square root of 3000?
Dad, the square root of 3000 is 54.77.
Son, what is the square root of 4000?
Dad, the square root of 4000 is 63.25.
Son, what is the square root of 5000?
Dad, the square root of 5000 is 70.71.
Son, what is the square root of 6000?
SonDad, the square root of 6000 is 77.46.
, what is the square root of 7000?
Dad, the square root of 7000 is 83.67.
Son, what is the square root of 8000?
Dad, the square root of 8000 is 89.44.

Exemple 2

L’exemple de code est une application de filtre de base. Il génère l’application crt_pipe_beeper après avoir créé un canal qui dirige l’application stdout générée vers le filtre. Le filtre supprime les caractères ASCII 7 (beep).

// crt_pipe_beeper.c

#include <stdio.h>
#include <string.h>

int main()
{
   int   i;
   for(i=0;i<10;++i)
      {
         printf("This is speaker beep number %d...\n\7", i+1);
      }
   return 0;
}

Voici l’application de filtre effective :

// crt_pipe_BeepFilter.C
// arguments: crt_pipe_beeper.exe

#include <windows.h>
#include <process.h>
#include <memory.h>
#include <string.h>
#include <stdio.h>
#include <fcntl.h>
#include <io.h>

#define   OUT_BUFF_SIZE 512
#define   READ_FD 0
#define   WRITE_FD 1
#define   BEEP_CHAR 7

char szBuffer[OUT_BUFF_SIZE];

int Filter(char* szBuff, ULONG nSize, int nChar)
{
   char* szPos = szBuff + nSize -1;
   char* szEnd = szPos;
   int nRet = nSize;

   while (szPos > szBuff)
   {
      if (*szPos == nChar)
         {
            memmove(szPos, szPos+1, szEnd - szPos);
            --nRet;
         }
      --szPos;
   }
   return nRet;
}

int main(int argc, char** argv)
{
   int nExitCode = STILL_ACTIVE;
   if (argc >= 2)
   {
      HANDLE hProcess;
      int fdStdOut;
      int fdStdOutPipe[2];

      // Create the pipe
      if(_pipe(fdStdOutPipe, 512, O_NOINHERIT) == -1)
         return   1;

      // Duplicate stdout file descriptor (next line will close original)
      fdStdOut = _dup(_fileno(stdout));

      // Duplicate write end of pipe to stdout file descriptor
      if(_dup2(fdStdOutPipe[WRITE_FD], _fileno(stdout)) != 0)
         return   2;

      // Close original write end of pipe
      _close(fdStdOutPipe[WRITE_FD]);

      // Spawn process
      hProcess = (HANDLE)_spawnvp(P_NOWAIT, argv[1],
       (const char* const*)&argv[1]);

      // Duplicate copy of original stdout back into stdout
      if(_dup2(fdStdOut, _fileno(stdout)) != 0)
         return   3;

      // Close duplicate copy of original stdout
      _close(fdStdOut);

      if(hProcess)
      {
         int nOutRead;
         while   (nExitCode == STILL_ACTIVE)
         {
            nOutRead = _read(fdStdOutPipe[READ_FD],
             szBuffer, OUT_BUFF_SIZE);
            if(nOutRead)
            {
               nOutRead = Filter(szBuffer, nOutRead, BEEP_CHAR);
               fwrite(szBuffer, 1, nOutRead, stdout);
            }

            if(!GetExitCodeProcess(hProcess,(unsigned long*)&nExitCode))
               return 4;
         }
      }
   }
   return nExitCode;
}
This is speaker beep number 1...
This is speaker beep number 2...
This is speaker beep number 3...
This is speaker beep number 4...
This is speaker beep number 5...
This is speaker beep number 6...
This is speaker beep number 7...
This is speaker beep number 8...
This is speaker beep number 9...
This is speaker beep number 10...

Voir aussi

Processus et contrôle d’environnement
_open, _wopen