summaryrefslogtreecommitdiff
path: root/hv.h
diff options
context:
space:
mode:
authorFather Chrysostomos <sprout@cpan.org>2011-09-20 15:39:32 -0700
committerFather Chrysostomos <sprout@cpan.org>2011-10-06 13:00:58 -0700
commitd9021235b07b60ed76d1f7e02223897f5afccbb7 (patch)
tree7077fdae1607fb6d04455cab2d8136d2c73e83e3 /hv.h
parentb2c03ebdf370f093a95cbbc154411f05c13e5913 (diff)
downloadperl-d9021235b07b60ed76d1f7e02223897f5afccbb7.tar.gz
Document and apiify hv name length/utf8 macros
Diffstat (limited to 'hv.h')
-rw-r--r--hv.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/hv.h b/hv.h
index 4eafcc6cf2..78f377160f 100644
--- a/hv.h
+++ b/hv.h
@@ -175,6 +175,12 @@ Null HV pointer.
Returns the package name of a stash, or NULL if C<stash> isn't a stash.
See C<SvSTASH>, C<CvSTASH>.
+=for apidoc Am|STRLEN|HvNAMELEN|HV *stash
+Returns the length of the stash's name.
+
+=for apidoc Am|unsigned char|HvNAMEUTF8|HV *stash
+Returns true if the name is in UTF8 encoding.
+
=for apidoc Am|char*|HvENAME|HV* stash
Returns the effective name of a stash, or NULL if there is none. The
effective name represents a location in the symbol table where this stash
@@ -183,6 +189,12 @@ A stash that is no longer in the symbol table has no effective name. This
name is preferable to C<HvNAME> for use in MRO linearisations and isa
caches.
+=for apidoc Am|STRLEN|HvENAMELEN|HV *stash
+Returns the length of the stash's effective name.
+
+=for apidoc Am|unsigned char|HvENAMEUTF8|HV *stash
+Returns true if the effective name is in UTF8 encoding.
+
=for apidoc Am|void*|HeKEY|HE* he
Returns the actual pointer stored in the key slot of the hash entry. The
pointer may be either C<char*> or C<SV*>, depending on the value of