PIPESEMSTATE: Difference between revisions

Latest revision as of 08:32, 6 January 2017

Status of a named pipe that is attached to a semaphore.

Type

BYTE   fStatus;
BYTE   fFlag
USHORT  usKey;
USHORT  usAvail

C Declaration Method

typedef struct

Fields

fStatus

A coded value that indicates the status of the named pipe.

The following codes are available:

0 - NPSS_EOI

End of information buffer. No more information records follow, and subsequent fields in this information record have no defined value.

1 - NPSS_RDATA

Read data is available.

2 - NPSS_WSPACE

Write space is available.

3 - NPSS_CLOSE

The pipe is closed.

fFlag: Additional information about the state of the named pipe.; This parameter contains the following bit fields:; Bit 7-1 - Reserved; Bit 0 - NPSS_WAIT - If set, a thread is waiting at the other end of the pipe.
usKey: A key value that distinguishes events arriving on different named pipes that are attached to the same semaphore.; This value is specified in the key field when DosSetNPipeSem is issued.
usAvail: Number of bytes available in the pipe.; If fStatus has a value of 1, this field contains the number of bytes of data that are available to read from the pipe. If fStatus has a value of 2, this field contains the number of bytes of write space that are available in the pipe.

@@ Line 1: / Line 1: @@
-== PIPESEMSTATE ==
 Status of a named pipe that is attached to a semaphore.
 === Type ===
-  [[OS2 API:DataType:BYTE|BYTE]]   fStatus;
+  [[BYTE]]   fStatus;
-  [[OS2 API:DataType:BYTE|BYTE]]   fFlag
+  BYTE   fFlag
-  [[OS2 API:DataType:USHORT|USHORT]]  usKey;
+  [[USHORT]]  usKey;
-  [[OS2 API:DataType:USHORT|USHORT]]  usAvail
+  USHORT  usAvail
 ==== C Declaration Method ====
@@ Line 12: / Line 11: @@
 === Fields ===
- fStatus  A coded value that indicates the status of the named pipe.
+;fStatus:A coded value that indicates the status of the named pipe.
-          The following codes are available:
+:The following codes are available:
-NPSS_EOI
+:0 - NPSS_EOI
-             End of information buffer. No more information records follow, and
+::End of information buffer. No more information records follow, and subsequent fields in this information record have no defined value.
-             subsequent fields in this information record have no defined value.
+:1 - NPSS_RDATA
-NPSS_RDATA
+::Read data is available.
-             Read data is available.
+:2 - NPSS_WSPACE
-NPSS_WSPACE
+::Write space is available.
-             Write space is available.
+:3 - NPSS_CLOSE
-NPSS_CLOSE
+::The pipe is closed.
-             The pipe is closed.
+;fFlag:Additional information about the state of the named pipe.
+:This parameter contains the following bit fields:
- fFlag    Additional information about the state of the named pipe.
+:Bit 7-1 - Reserved
-          This parameter contains the following bit fields:
+:Bit 0 - NPSS_WAIT - If set, a thread is waiting at the other end of the pipe.
-          Bit  Description
+;usKey:A key value that distinguishes events arriving on different named pipes that are attached to the same semaphore.
--1  Reserved
+:This value is specified in the key field when DosSetNPipeSem is issued.
-   NPSS_WAIT
+;usAvail:Number of bytes available in the pipe.
-               If set, a thread is waiting at the other end of the pipe.
+:If fStatus has a value of 1, this field contains the number of bytes of data that are available to read from the pipe. If fStatus has a value of 2, this field contains the number of bytes of write space that are available in the pipe.
- usKey    A key value that distinguishes events arriving on different named
-          pipes that are attached to the same semaphore. This value is specified
-          in the key field when DosSetNPipeSem is issued.
- usAvail  Number of bytes available in the pipe.
-          If fStatus has a value of 1, this field contains the number of bytes
-          of data that are available to read from the pipe. If fStatus has a
-          value of 2, this field contains the number of bytes of write space
-          that are available in the pipe.
-[[Category:The OS/2 API Project]]
+[[Category:Data type]]