[p5sagit/p5-mst-13.2.git] / pod / perlintern.pod

=head1 NAME

perlintern - autogenerated documentation of purely B<internal> 
		 Perl functions

=head1 DESCRIPTION

This file is the autogenerated documentation of functions in the 
Perl interpreter that are documented using Perl's internal documentation
format but are not marked as part of the Perl API. In other words, 
B<they are not for use in extensions>!

=over 8

=item is_gv_magical

Returns C<TRUE> if given the name of a magical GV.

Currently only useful internally when determining if a GV should be
created even in rvalue contexts.

C<flags> is not used at present but available for future extension to
allow selecting particular classes of magical variable.

	bool	is_gv_magical(char *name, STRLEN len, U32 flags)

=back

=head1 AUTHORS

The autodocumentation system was originally added to the Perl core by 
Benjamin Stuhl. Documentation is by whoever was kind enough to 
document their functions.

=head1 SEE ALSO

perlguts(1), perlapi(1)
Commit	Line	Data
954c1994	1	=head1 NAME
	2
	3	perlintern - autogenerated documentation of purely B<internal>
	4	Perl functions
	5
	6	=head1 DESCRIPTION
	7
	8	This file is the autogenerated documentation of functions in the
4375e838	9	Perl interpreter that are documented using Perl's internal documentation
954c1994	10	format but are not marked as part of the Perl API. In other words,
	11	B<they are not for use in extensions>!
	12
	13	=over 8
	14
c9d5ac95	15	=item is_gv_magical
	16
	17	Returns C<TRUE> if given the name of a magical GV.
	18
	19	Currently only useful internally when determining if a GV should be
	20	created even in rvalue contexts.
	21
	22	C<flags> is not used at present but available for future extension to
	23	allow selecting particular classes of magical variable.
	24
	25	bool is_gv_magical(char *name, STRLEN len, U32 flags)
	26
954c1994	27	=back
	28
	29	=head1 AUTHORS
	30
4375e838	31	The autodocumentation system was originally added to the Perl core by
954c1994	32	Benjamin Stuhl. Documentation is by whoever was kind enough to
	33	document their functions.
	34
	35	=head1 SEE ALSO
	36
	37	perlguts(1), perlapi(1)
	38