PCRE_COPY_NAMED_SUBSTRING(3)Library Functions ManualPCRE_COPY_NAMED_SUBSTRING(3)



NNAAMMEE
       PCRE - Perl-compatible regular expressions

SSYYNNOOPPSSIISS

       ##iinncclluuddee <<ppccrree..hh>>

       iinntt ppccrree__ccooppyy__nnaammeedd__ssuubbssttrriinngg((ccoonnsstt ppccrree **_c_o_d_e,,
            ccoonnsstt cchhaarr **_s_u_b_j_e_c_t,, iinntt **_o_v_e_c_t_o_r,,
            iinntt _s_t_r_i_n_g_c_o_u_n_t,, ccoonnsstt cchhaarr **_s_t_r_i_n_g_n_a_m_e,,
            cchhaarr **_b_u_f_f_e_r,, iinntt _b_u_f_f_e_r_s_i_z_e));;

       iinntt ppccrree1166__ccooppyy__nnaammeedd__ssuubbssttrriinngg((ccoonnsstt ppccrree1166 **_c_o_d_e,,
            PPCCRREE__SSPPTTRR1166 _s_u_b_j_e_c_t,, iinntt **_o_v_e_c_t_o_r,,
            iinntt _s_t_r_i_n_g_c_o_u_n_t,, PPCCRREE__SSPPTTRR1166 _s_t_r_i_n_g_n_a_m_e,,
            PPCCRREE__UUCCHHAARR1166 **_b_u_f_f_e_r,, iinntt _b_u_f_f_e_r_s_i_z_e));;

       iinntt ppccrree3322__ccooppyy__nnaammeedd__ssuubbssttrriinngg((ccoonnsstt ppccrree3322 **_c_o_d_e,,
            PPCCRREE__SSPPTTRR3322 _s_u_b_j_e_c_t,, iinntt **_o_v_e_c_t_o_r,,
            iinntt _s_t_r_i_n_g_c_o_u_n_t,, PPCCRREE__SSPPTTRR3322 _s_t_r_i_n_g_n_a_m_e,,
            PPCCRREE__UUCCHHAARR3322 **_b_u_f_f_e_r,, iinntt _b_u_f_f_e_r_s_i_z_e));;

DDEESSCCRRIIPPTTIIOONN

       This  is  a  convenience  function for extracting a captured substring,
       identified by name, into a given buffer. The arguments are:

         _c_o_d_e          Pattern that was successfully matched
         _s_u_b_j_e_c_t       Subject that has been successfully matched
         _o_v_e_c_t_o_r       Offset vector that ppccrree[[1166||3322]]__eexxeecc(()) used
         _s_t_r_i_n_g_c_o_u_n_t   Value returned by ppccrree[[1166||3322]]__eexxeecc(())
         _s_t_r_i_n_g_n_a_m_e    Name of the required substring
         _b_u_f_f_e_r        Buffer to receive the string
         _b_u_f_f_e_r_s_i_z_e    Size of buffer

       The yield is the length of the substring,  PCRE_ERROR_NOMEMORY  if  the
       buffer  was  too small, or PCRE_ERROR_NOSUBSTRING if the string name is
       invalid.

       There is a complete description of the PCRE native API in  the  ppccrreeaappii
       page and a description of the POSIX API in the ppccrreeppoossiixx page.



PCRE 8.30                        24 June 2012     PCRE_COPY_NAMED_SUBSTRING(3)