Category : C Source Code
Archive   : WINPIPE.ZIP
Filename : REFRENCE.WRI
Reference
ClosePipe
Syntax
Pipe ClosePipe(Pipe)
Parameter Type/Description
Pipe PIPE Specifies a handle to a pipe.
Closes the pipe designated by Pipe.
Return Value
Handle to the closed pipe. No significance.
CreatePipe
Syntax
PIPE CreatePipe(hWnd, lpszPipeName, wStyle, wBufferSize, wNotify);
Parameter Type/Description
hWnd HWND Identifies the Window who owns the pipe.
lpszPipeName LPSTR Name of pipe to be created. (under 16 bytes)
wStyle WORD Bitwise ORing of Pipe styles.
wBufferSize WORD Size of Pipe buffer, zero for default.
wNotify WORD wParam passed to window with a WM_USER
message.
This function creates a pipe. A buffer is allocated within the DLL and information is stored about the pipe user. Access to the pipe is regulated by wStyle. If wNotify is non-zero this value will be sent to hWnd as wParam in a WM_USER message if wStyle is PIPE_READ or PIPE_WRITE. See Pipe Notification for more details.
Return Value
A handle to a pipe, or an error. An error is indicated by a number less than zero.
OpenPipe
Syntax
PIPE OpenPipe(hWnd, lpszPipeName, wStyle, wNotify);
Parameter Type/Description
hWnd HWND Identifies the Window who owns the pipe.
lpszPipeName LPSTR Name of pipe to be created. (under 16 bytes)
wStyle WORD Bitwise ORing of Pipe styles.
wNotify WORD wParam passed to window with a WM_USER
message.
This function is similar to CreatePipe except that a pipe is not actually created. This function sets the access rights a window has to a previously created pipe.
Return Value
A handle to the pipe or an error. An error is indicated by a number less than zero.
PeekPipe
Syntax
WORD PeekPipe(lpBuffer, iNum, Pipe);
Parameter Type/Description
lpBuffer LPSTR A buffer to contain data from pipe.
iNum int The number of bytes to copy from pipe
Pipe PIPE Valid pipe handle, can be a standard pipe or a pipe
handle obtained from an OpenPipe or a CreatePipe.
PeekPipe functions and behaves as a Pread except data is not removed from the pipe.
Return Value
The number of bytes actually copied into the pipe or an error. An error is indicated by a number less than zero.
PurgePipe
Syntax
PurgePipe(Pipe);
Parameter Type/Description
Pipe PIPE A handle to a valid pipe, can be a standard pipe or
a pipe handle obtained from an OpenPipe or a
CreatePipe.
PurgePipe purges all data in a pipe, resetting internal indexes to zero.
Return Value
Zero or error. Error is indicated by a number less than zero.
QueryPipe
Syntax
WORD QueryPipe(Pipe);
Parameter Type/Description
Pipe PIPE A handle to a valid pipe, can be a standard pipe or
a pipe handle obtained from an OpenPipe or a
CreatePipe.
QueryPipe checks the status of Pipe.
Return Value
The number of bytes in a pipe or error. An error is indicated by a number less than zero.
ReleasePipe
Syntax
WORD ReleasePipe(Pipe);
Parameter Type/Description
Pipe PIPE A handle to a valid pipe, can be a standard pipe or
a pipe handle obtained from an OpenPipe or a
CreatePipe.
ReleasePipe releases any READ or WRITE ownership on a pipe that a particular window may have.
Return Value
The original pipe handle or an error. An error is indicated by a number less than zero.
Pputc
Syntax
WORD Pputc(c, Pipe);
Parameter Type/Description
c char A character byte to be written to a pipe.
Pipe PIPE A handle to a valid pipe, can be a standard pipe or a
pipe handle obtained from an OpenPipe or a
CreatePipe.
Pputc puts a single character into a pipe.
Return Value
The number of bytes written or error. An error is indicated by a number less than zero.
Pputs
Syntax
WORD Pputs(lpszString, Pipe);
Parameter Type/Description
lpszString LPSTR A null terminated string.
Pipe PIPE A handle to a valid pipe, can be a standard pipe or
a pipe handle obtained from an OpenPipe or a
CreatePipe.
Pputs copies the contents of lpszString to the buffer of Pipe, up to but not including the terminating NULL character.
Return Value
The number of bytes written or error. An error is indicated by a number less than zero.
Pgetc
Syntax
WORD Pgetc(Pipe);
Parameter Type/Description
Pipe PIPE A handle to a valid pipe, can be a standard pipe or
a pipe handle obtained from an OpenPipe or a
CreatePipe.
Reads and removes a single byte from a pipe.
Return Value
The character read or an error. An error is indicated by a number less than zero.
Pgets
Syntax
WORD Pgets(lpszString, iNum, Pipe);
Parameter Type/Description
lpszString LPSTR A buffer to contain data from pipe.
iNum int The number of bytes to copy from pipe.
Pipe PIPE Valid pipe handle, can be a standard pipe or a pipe
handle obtained from an OpenPipe or a CreatePipe.
Pgets reads and removes up to iNum bytes from Pipe and copies them into the buffer pointed to by lpszString. The data is capped off with a terminating NULL character.
Return Value
The number of bytes actually read or an error. An error is indicated by a number less than zero.
Pread
Syntax
Pread(lpBuffer, iNum, Pipe);
Parameter Type/Description
lpBuffer LPSTR A buffer to contain data from pipe.
iNum int The number of bytes to copy from pipe.
Pipe PIPE Valid pipe handle, can be a standard pipe or a pipe
handle obtained from an OpenPipe or a CreatePipe.
Pread reads and removes iNum bytes from Pipe.
Return Value
The number of bytes actually read or an error. An error is indicated by a number less than zero.
Pwrite
Syntax
WORD Pwrite(lpBuffer,iItemSize, iCount, Pipe);
Parameter Type/Description
lpBuffer LPSTR A buffer of iCount data objects.
iItemSize int The size of objects contained in buffer.
iCount int The number of objects in lpBuffer.
Pipe PIPE Valid pipe handle, can be a standard pipe or a pipe
handle obtained from an OpenPipe or a CreatePipe.
Pwrite will write iCount objects of iItemSize to Pipe.
Return Value
The number of bytes actually written or an error. An error is indicated by a number less than zero.
Wgetc
Syntax
WORD Wgetc();
Wgetc reads and removes one byte from the standard pipe "Stdin."
Return Value
The character read or an error. An error is indicated by a number less than zero.
Wgets
Syntax
Wgets(lpszString, iNum);
Parameter Type/Description
lpszString LPSTR A buffer to contain returned string.
iNum int The number of bytes to read.
Wgets reads and removes iNum characters from the standard pipe "Stdin."
Return Value
The number of bytes actually read or an error. An error is indicated by a number less than zero.
Wputc
Syntax
WORD Wputc(c);
Parameter Type/Description
c char The byte to be written.
Wputc writes one byte, c, to the standard pipe "Stdout."
Return Value
The number of bytes actually written or an error. An error is indicated by a number less than zero.
Wputs
Syntax
Wputs(lpszString);
Parameter Type/Description
lpszString LPSTR The string to be written.
Wputs writes a null terminated string, up to but not including the terminating NULL character to the standard pipe "Stdout."
Return Value
The number of bytes actually written or an error. An error is indicated by a number less than zero.
Wprintf
Syntax
WORD Wprintf(lpszFmt,[argument]...);
Parameter Type/Description
lpszFmt LPSTR The printf format string.
argument One or more optional parameters. See page 4-465 of the Windows
SDK reference Volume #1. This function has the same arguments and
syntax as "wsprintf," except for lpOutput which in this case is the
standard pipe Stdout.
Writes a printf format string and following arguments to the standard pipe "Stdout."
Return Value
The number of bytes written or an error. An error is indicated by a number less than zero.
Comments
This function uses the Windows function wvsprintf for the string formatting. All limitations that apply to wvsprintf apply to this function also.Furthermore, a temporary buffer is used as storage for the wvsprintf call; its maximum size is 1024 bytes.
to but not including the terminating NULL character.
Return Value
The n ÿÿ x u £ q ¹ m Ø h à d ä ` \ X , T . ÿÿ< P
< m w y t p Ç l ä g ì c ò _ + [ 1 W j S o O K < ¢ w Ö s Ú o ¬ k ³ g · c ¾ _ æ [ ê W
S O 4 K < 4 E w V s W o [ k i g Á c Ë ` Ó \ X ' S / O 3 K < 3 n w s s o ± k Ý g á c à _ Ñ [ ( W * R , N 6 K < 6 > w d s n j f Á b Ä ^ ÷ Z û V Å R Ó N I J < I T x \ t n p k g c d
_ r
[ ³
W µ
S À
P È
L < È
ã
w r n j ´ f ¶ b Ä ^ # Z 0 W 8 S S O p J < p x w | s ]
o k
k È
g Ï
d ×
` ï
\ W S O K K < K O w Í s Ï o û k ý g c h _ o \ w X T µ O Â K < Â Ç w í s ñ o q k s g ë c í _ û [ X W _ T g P | L < | v ¡ r ¥ n T j V f d b · ^ » Z Â W Ê S ñ O J < w s O o R k g c © _ · [ W $ T , P L L < L i v u r z n © j ¬ f à b ä ^ V Z X V R N J < ý w t
p ? l \ g h c m _ [ W Ø S Û O
K <
w ¼ s Ê o 3 k : h B d S ` \ ¥ X ü T Q M < ' w D r Q n V j f b ÷ ^ Z k V r S z O K < § v ¬ r ³ n
j f b _ [ ¦ W Ã R Ð N Õ J < Õ u w s ê o ì k õ h ý d ` \ % X B S M O R K < R À w Î s * o 6 k 5! g ý d ` \ % X B S M O R K < t q q ÿÿ£ ÿÿ¹ h » ] Ø ] [ ÿÿ, R . ÿÿ< ÿÿ Ð
p`ú Ð
< i r k r m r y ÿÿ ÿÿÅ i Ç i ä ^ \ ` \ \ Ë \ \ \ \
p`ú Ð Ð Y r [ r i ÿÿ½ i ¿ g Á g Ë ÿÿÓ ÿÿ ^
S ' S _ Q £ Q
p`ú Ð Ð Ð
£ Ò y y y y Á p à p Ñ ÿÿ& g ( g * \ , S 6 ÿÿ> ÿÿ Ð
p`ú Ð Ð
> d r g ¹ e ï e 2 e l e n e à \ Å \ Ó ÿÿE S G S I S Ð Ð
p`ú Ð
I T ÿÿ\ ÿÿn r g Ï e
e
e
e b
\ d
\ r
ÿÿ±
S ³
S Ð Ð
p`ú Ð
³
µ
ÿÿÀ
ÿÿÈ
ÿÿá
r ã
r g D e y e e e ´ \ ¶ \ Ä ÿÿ Ð Ð
p`ú Ð
Ä r ! r # r 0 ÿÿ8 ÿÿQ i S i p ^ ³ \ ç \ ú \ ü \ [
S Ð
p`ú Ð Ð
[
]
r k
ÿÿÄ
i Æ
i È
i Ï
ÿÿ×
ÿÿí
` ï
` U C S S º S
p`ú Ð Ð Ð
º Í y Ï p û p ý p ÿÿd g f g h g o ÿÿw ÿÿ ^ ^ µ S
p`ú Ð Ð Ð
µ å y * y ^ y q y s p ë p í p û ÿÿT g V g X g _ ÿÿg ÿÿz ^ | ^ p`ú Ð Ð Ð | p Ý n n $ n & n T e V e d ÿÿ· \ ¹ ÿÿ» ÿÿÂ ÿÿÊ ÿÿz ^ | ^ p Ð Ð
p`ú
Ê ï r ñ r g G e ~ e à e ü e þ e § \ © \ · ÿÿ S S z ^ Ð Ð
p`ú Ð
r $ ÿÿ, ÿÿJ i L i i ^ ¡ \ Ø \ \ V \ X S S S z ^ Ð
p`ú Ð Ð
ÿÿù r û r ý r ÿÿ
ÿÿ= i ? i \ ^ \ Î \ \ G \ \ \ Ð
p`ú Ð Ð º r ¼ r Ê ÿÿ/ i 1 i 3 i : ÿÿB ÿÿQ ` S ` ` ` ¥ ÿÿø W Ð Ð Ð Ðø ú r ü r ÿÿ ÿÿ% i ' i D ^ ~ \ ª \ ¬ \ õ S ÷ S ÿÿø W Ð
p`ú Ð Ð
g r i r k r r ÿÿz ÿÿ i § ^ Ì \ Î \ S
S ÿÿ ÿÿø W Ð
p`ú Ð Ð } r r r ÿÿ ÿÿ¤ i ¦ i à ^ ó \ õ \ s S u S ÿÿø W Ð
p`ú Ð Ð
è r ê r ì ÿÿõ ÿÿý ÿÿ# i % i B ^ p \ » \ \ K \ f \ h \ Ð
p`ú Ð Ðh ¾ r À r Î ÿÿ* i , ÿÿ6 ÿÿ3! ` 5! ` 7! ` » \ \ K \ f \ h \ Ð
Ð Ð Ð f à=Ð/ÿÿ 2À! Ð;Ð ÐÈ( µ 6 ¶ ÿÿÿÿÿ k ý g c h _ o \ w X T µ O Â K < Tms Rmn Helv k s g ë c í _ û [ X W _ T g P | L <
Very nice! Thank you for this wonderful archive. I wonder why I found it only now. Long live the BBS file archives!
This is so awesome! 😀 I’d be cool if you could download an entire archive of this at once, though.
But one thing that puzzles me is the “mtswslnkmcjklsdlsbdmMICROSOFT” string. There is an article about it here. It is definitely worth a read: http://www.os2museum.com/wp/mtswslnk/