This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Refer to CopLABEL_len[_flags] in pod for cop_fetch_label
authorKarl Williamson <khw@cpan.org>
Sat, 31 Aug 2019 20:12:49 +0000 (14:12 -0600)
committerKarl Williamson <khw@cpan.org>
Tue, 3 Sep 2019 03:52:11 +0000 (21:52 -0600)
hv.c

diff --git a/hv.c b/hv.c
index 0dbd900..da0014c 100644 (file)
--- 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
 */