---
name: "gnutls_record_get_state"
section: "3"
platform: "linux"
package: "gnutls"
version: "3.8.13-3"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/gnutls_record_get_state"
---

# gnutls\_record\_get\_state(3)

API function

## NAME

gnutls\_record\_get\_state - API function

## SYNOPSIS

**#include \<gnutls/gnutls.h\>**

**int gnutls\_record\_get\_state(gnutls\_session\_t** *session***, unsigned** *read***, gnutls\_datum\_t \*** *mac\_key***, gnutls\_datum\_t \*** *IV***, gnutls\_datum\_t \*** *cipher\_key***, unsigned char \[8\]** *seq\_number***);**

## ARGUMENTS

- gnutls\_session\_t session

  is a **gnutls\_session\_t** type

- unsigned read

  if non-zero the read parameters are returned, otherwise the write

- gnutls\_datum\_t \* mac\_key

  the key used for MAC (if a MAC is used)

- gnutls\_datum\_t \* IV

  the initialization vector or nonce used

- gnutls\_datum\_t \* cipher\_key

  the cipher key

- unsigned char \[8\] seq\_number

  A 64-bit sequence number

## DESCRIPTION

This function will return the parameters of the current record state. These are only useful to be provided to an external off-loading device or subsystem. The returned values should be considered constant and valid for the lifetime of the session.

In that case, to sync the state back you must call **gnutls\_record\_set\_state()**.

## RETURNS

**GNUTLS\_E\_SUCCESS** on success, or an error code.

Since 3.4.0

## REPORTING BUGS

Report bugs to \<bugs@gnutls.org\>.\
 Home page: https://www.gnutls.org

## COPYRIGHT

Copyright © 2001-2023 Free Software Foundation, Inc., and others.\
 Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved.

## SEE ALSO

The full documentation for **gnutls** is maintained as a Texinfo manual. If the /usr/share/doc/gnutls/ directory does not contain the HTML form visit

- https://www.gnutls.org/manual/