---
name: "gnutls_x509_key_purpose_get"
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_x509_key_purpose_get"
---

# gnutls\_x509\_key\_purpose\_get(3)

API function

## NAME

gnutls\_x509\_key\_purpose\_get - API function

## SYNOPSIS

**#include \<gnutls/x509-ext.h\>**

**int gnutls\_x509\_key\_purpose\_get(gnutls\_x509\_key\_purposes\_t** *p***, unsigned** *idx***, gnutls\_datum\_t \*** *oid***);**

## ARGUMENTS

- gnutls\_x509\_key\_purposes\_t p

  The key purposes

- unsigned idx

  The index of the key purpose to retrieve

- gnutls\_datum\_t \* oid

  Will hold the object identifier of the key purpose (to be treated as constant)

## DESCRIPTION

This function will retrieve the specified by the index key purpose in the purposes type. The object identifier will be a null terminated string.

## RETURNS

On success, **GNUTLS\_E\_SUCCESS** (0) is returned, **GNUTLS\_E\_REQUESTED\_DATA\_NOT\_AVAILABLE** if the index is out of bounds, otherwise a negative error value.

## SINCE

3\.3.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/