summaryrefslogtreecommitdiff
path: root/hv.c
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2019-08-31 14:12:49 -0600
committerKarl Williamson <khw@cpan.org>2019-09-02 21:52:11 -0600
commit7df56744f9fc5926b6e799aa9c077c1e57807217 (patch)
treee18319bcc6848e7fa72aec2430216d297a26371b /hv.c
parent33d29c13d9ccce7504cb777504931dcf2182e9d8 (diff)
downloadperl-7df56744f9fc5926b6e799aa9c077c1e57807217.tar.gz
Refer to CopLABEL_len[_flags] in pod for cop_fetch_label
Diffstat (limited to 'hv.c')
-rw-r--r--hv.c10
1 files changed, 8 insertions, 2 deletions
diff --git a/hv.c b/hv.c
index 0dbd900d74..da0014c1ce 100644
--- a/hv.c
+++ b/hv.c
@@ -3746,8 +3746,14 @@ Perl_refcounted_he_inc(pTHX_ struct refcounted_he *he)
/*
=for apidoc cop_fetch_label
-Returns the label attached to a cop.
-The flags pointer may be set to C<SVf_UTF8> or 0.
+Returns the label attached to a cop, and stores its length in bytes into
+C<*len>.
+Upon return, C<*flags> will be set to either C<SVf_UTF8> or 0.
+
+Alternatively, use the macro L</C<CopLABEL_len_flags>>;
+or if you don't need to know if the label is UTF-8 or not, the macro
+L</C<CopLABEL_len>>;
+or if you additionally dont need to know the length, L</C<CopLABEL>>.
=cut
*/