summaryrefslogtreecommitdiff
path: root/pod/perlapi.pod
diff options
context:
space:
mode:
authorJohn Peacock <jpeacock@rowman.com>2001-12-25 01:02:12 -0500
committerJarkko Hietaniemi <jhi@iki.fi>2001-12-25 15:56:49 +0000
commit7c9e965c652c539b7064f0b192c92dbee8a21bcc (patch)
tree8bec7dba8caa94efdcd93023f5c8266ea1dba311 /pod/perlapi.pod
parent763acdb292c461fc4a4211ff9618bbb2633f83b9 (diff)
downloadperl-7c9e965c652c539b7064f0b192c92dbee8a21bcc.tar.gz
Re: Not OK 13881
Message-ID: <3C285CB4.8040006@rowman.com> p4raw-id: //depot/perl@13883
Diffstat (limited to 'pod/perlapi.pod')
-rw-r--r--pod/perlapi.pod58
1 files changed, 39 insertions, 19 deletions
diff --git a/pod/perlapi.pod b/pod/perlapi.pod
index 3f82777366..ee5d65abeb 100644
--- a/pod/perlapi.pod
+++ b/pod/perlapi.pod
@@ -465,6 +465,26 @@ then.
=for hackers
Found in file util.c
+=item form
+
+Takes a sprintf-style format pattern and conventional
+(non-SV) arguments and returns the formatted string.
+
+ (char *) Perl_form(pTHX_ const char* pat, ...)
+
+can be used any place a string (char *) is required:
+
+ char * s = Perl_form("%d.%d",major,minor);
+
+Uses a single private buffer so if you want to format several strings you
+must explicitly copy the earlier strings away (and free the copies when you
+are done).
+
+ char* form(const char* pat, ...)
+
+=for hackers
+Found in file util.c
+
=item FREETMPS
Closing bracket for temporaries on a callback. See C<SAVETMPS> and
@@ -1420,17 +1440,6 @@ SV is B<not> incremented.
=for hackers
Found in file sv.c
-=item newSV
-
-Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
-with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
-macro.
-
- SV* newSV(STRLEN len)
-
-=for hackers
-Found in file sv.c
-
=item NEWSV
Creates a new SV. A non-zero C<len> parameter indicates the number of
@@ -1444,6 +1453,17 @@ C<id> is an integer id between 0 and 1299 (used to identify leaks).
=for hackers
Found in file handy.h
+=item newSV
+
+Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
+with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
+macro.
+
+ SV* newSV(STRLEN len)
+
+=for hackers
+Found in file sv.c
+
=item newSViv
Creates a new SV and copies an integer into it. The reference count for the
@@ -2996,22 +3016,22 @@ for a version which guarantees to evaluate sv only once.
=for hackers
Found in file sv.h
-=item SvUVX
+=item SvUVx
-Returns the raw value in the SV's UV slot, without checks or conversions.
-Only use when you are sure SvIOK is true. See also C<SvUV()>.
+Coerces the given SV to an unsigned integer and returns it. Guarantees to
+evaluate sv only once. Use the more efficient C<SvUV> otherwise.
- UV SvUVX(SV* sv)
+ UV SvUVx(SV* sv)
=for hackers
Found in file sv.h
-=item SvUVx
+=item SvUVX
-Coerces the given SV to an unsigned integer and returns it. Guarantees to
-evaluate sv only once. Use the more efficient C<SvUV> otherwise.
+Returns the raw value in the SV's UV slot, without checks or conversions.
+Only use when you are sure SvIOK is true. See also C<SvUV()>.
- UV SvUVx(SV* sv)
+ UV SvUVX(SV* sv)
=for hackers
Found in file sv.h