Website hosting service by

 Back to Index


perlapi - autogenerated documentation for the perl public API


This file contains the documentation of the perl public API generated by, specifically a listing of functions, macros, flags, and variables that may be used by extension writers. The interfaces of any functions that are not listed here are subject to change without notice. For this reason, blindly using functions listed in proto.h is to be avoided when writing extensions.

Note that all Perl API global variables must be referenced with the PL_ prefix. Some macros are provided for compatibility with the older, unadorned names, but this support may be disabled in a future release.

The listing is alphabetical, case insensitive.

Cloning an interpreter


Create and return a new interpreter by cloning the current one.

	PerlInterpreter*	perl_clone(PerlInterpreter* interp, UV flags) 

Functions in file pp_pack.c


The engine implementing pack() Perl function.

	void	pack_cat(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)  


The engine implementing unpack() Perl function.

	I32	unpack_str(char *pat, char *patend, char *s, char *strbeg, char *strend, char **new_s, I32 ocnt, U32 flags)  

Handy Values


This flag, used in the length slot of hash entries and magic structures, specifies the structure contains an SV* pointer where a char* pointer is to be expected. (For information only--not to be used).

Null character pointer. =for hackers Found in file handy.h

Null SV pointer.


Until May 1997, this document was maintained by Jeff Okamoto <>. It is now maintained as part of Perl itself.

With lots of help and suggestions from Dean Roehrich, Malcolm Beattie, Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer, Stephen McCamant, and Gurusamy Sarathy.

API Listing originally by Dean Roehrich <>.

Updated to be autogenerated from comments in the source by Benjamin Stuhl.


perlguts(1), perlxs(1), perlxstut(1), perlintern(1)




© 2002-2004 Web Site Hosting Service


[ Don't get suckered in by the comments— they can be terribly misleading. Debug only code.   ]

Disclaimer: This documentation is provided only for the benefits of our web hosting customers.
For authoritative source of the documentation, please refer to