AVAILDATA: Difference between revisions

Latest revision as of 17:24, 2 May 2025

Four-byte buffer in which the system returns the number of bytes that were available in the named pipe.

USHORT cbpipe;
USHORT cbmessage;

typedef struct

cbpipe: Number of bytes that were buffered in the pipe, including the message-header bytes and bytes that have been examined.
cbmessage: Number of bytes in the current message. A value of 0 indicates a byte-stream pipe.

typedef struct _AVAILDATA
{
   USHORT cbpipe;      /* bytes left in pipe. */
   USHORT cbmessage;   /* bytes left in current message. */
} AVAILDATA;

@@ Line 1: / Line 1: @@
-== AVAILDATA ==
+Four-byte buffer in which the system returns the number of bytes that were available in the named pipe.
-Four-byte buffer in which the system returns the number of bytes that were
+==Type ==
-available in the named pipe.
+  [[USHORT]] cbpipe;
+  USHORT cbmessage;
-=== Type ===
-  [[OS2 API:DataType:USHORT|USHORT]] cbpipe;
-  [[OS2 API:DataType:USHORT|USHORT]] cbmessage;
-==== C Declaration Method ====
+==C Declaration Method ==
 typedef struct
+== Fields ==
+;cbpipe:Number of bytes that were buffered in the pipe, including the message-header bytes and bytes that have been examined.
+;cbmessage:Number of bytes in the current message. A value of 0 indicates a byte-stream pipe.
-=== Fields ===
+==Example Code==
+<pre>
+typedef struct _AVAILDATA
+{
+   USHORT cbpipe;      /* bytes left in pipe. */
+   USHORT cbmessage;   /* bytes left in current message. */
+} AVAILDATA;
+</pre>
- cbpipe    Number of bytes that were buffered in the pipe, including the
-           message-header bytes and bytes that have been examined.
- cbmessage Number of bytes in the current message. A value of 0 indicates
-           a byte-stream pipe.
-[[Category:The OS/2 API Project]]
+[[Category:Data type]]