PCRE2\_SERIALIZE\_DECODE(3) Library Functions Manual PCRE2\_SERIALIZE\_DECODE(3)

# [NAME](#NAME)

PCRE2 - Perl-compatible regular expressions (revised API)

# [SYNOPSIS](#SYNOPSIS)

**#include <pcre2.h>**

```
int32_t pcre2_serialize_decode(pcre2_code **codes,
  int32_t number_of_codes, const uint8_t *bytes,
  pcre2_general_context *gcontext);
```

# [DESCRIPTION](#DESCRIPTION)

This function decodes a serialized set of compiled patterns back into a list of individual patterns. This is possible only on a host that is running the same version of PCRE2, with the same code unit width, and the host must also have the same endianness, pointer width and PCRE2\_SIZE type. The arguments for **pcre2\_serialize\_decode()** are:

*codes* pointer to a vector in which to build the list  
*number\_of\_codes* number of slots in the vector  
*bytes* the serialized byte stream  
*gcontext* pointer to a general context or NULL

The *bytes* argument must point to a block of data that was originally created by **pcre2\_serialize\_encode()**, though it may have been saved on disc or elsewhere in the meantime. If there are more codes in the serialized data than slots in the list, only those compiled patterns that will fit are decoded. The yield of the function is the number of decoded patterns, or one of the following negative error codes:

PCRE2\_ERROR\_BADDATA *number\_of\_codes* is zero or less  
PCRE2\_ERROR\_BADMAGIC mismatch of id bytes in *bytes*  
PCRE2\_ERROR\_BADMODE mismatch of variable unit size or PCRE version  
PCRE2\_ERROR\_NOMEMORY memory allocation failed  
PCRE2\_ERROR\_NULL *codes* or *bytes* is NULL

PCRE2\_ERROR\_BADMAGIC may mean that the data is corrupt, or that it was compiled on a system with different endianness.

There is a complete description of the PCRE2 native API in the **pcre2api** page and a description of the serialization functions in the **pcre2serialize** page.

22 April 2022 PCRE2 10.49

---

Document: pcre2_serialize_decode(3) from pcre2 10.49-r2 (Chainguard OS)
Source: https://github.com/PCRE2Project/pcre2.git