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

# [NAME](#NAME)

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

# [SYNOPSIS](#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](#ARGUMENTS)

[gnutls\_x509\_key\_purposes\_t p](#gnutls_x509_key_purposes_t)

The key purposes

[unsigned idx](#unsigned)

The index of the key purpose to retrieve

[gnutls\_datum\_t * oid](#gnutls_datum_t)

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

# [DESCRIPTION](#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](#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](#SINCE)

3.3.0

# [REPORTING BUGS](#REPORTING_BUGS)

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

# [COPYRIGHT](#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](#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/](https://www.gnutls.org/manual/)

3.8.13 gnutls

---

Document: gnutls_x509_key_purpose_get(3) from gnutls 3.8.13-r1 (Chainguard OS)
Source: https://gitlab.com/gnutls/gnutls