GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  BOUNDARY_FOPEN (3)

NAME

boundary_fopen - read from a stream until a boundary string is matched

CONTENTS

Library
Synopsis
Description
Return Values
See Also
History
Authors

LIBRARY

PDEL Library (libpdel, -lpdel)

SYNOPSIS


.In stdio.h
.In pdel/io/boundary_fp.h FILE * boundary_fopen FILE *fp const char *boundary int closeit

DESCRIPTION

boundary_fopen creates a new read-only stream that reads data from the underlying stream fp until the boundary string is encountered, after which EOF is returned. If the boundary string does not appear in the underlying stream input, the entire input is passed through unaltered.

When the boundary string appears, the last character readable from the newly created boundary stream will be the character just before the first character of the boundary string. Therefore, the boundary string itself does not appear in the input from the boundary stream. In no case are any characters beyond the last character of the boundary string read out from the underlying stream, i.e., the last character read from the underlying stream will be the last character of the boundary string.

The boundary matching algorithm runs in linear time. However, the boundary string is limited to 255 characters in length (not counting the terminating ’\0’ byte).

fclose(3) should be used to close the returned stream. The closeit parameter determines whether the underlying stream fp is also closed when the boundary stream is closed.

Boundary streams are useful for online parsing of multipart MIME document body parts as defined in RFC 2046.

RETURN VALUES

boundary_fopen returns NULL to indicate an error, with errno set appropriately.

SEE ALSO

count_fopen(3), string_fp(3), libpdel(3)
.Rs Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types
.Re

HISTORY

The PDEL library was developed at Packet Design, LLC. http://www.packetdesign.com/

AUTHORS


.An Archie Cobbs Aq archie@freebsd.org
Search for    or go to Top of page |  Section 3 |  Main Index


Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.