~ubuntu-branches/ubuntu/quantal/gnutls26/quantal

« back to all changes in this revision

Viewing changes to doc/manpages/gnutls_x509_crq_get_key_purpose_oid.3

  • Committer: Bazaar Package Importer
  • Author(s): Steve Langasek
  • Date: 2011-05-20 13:07:18 UTC
  • mfrom: (12.1.11 sid)
  • Revision ID: james.westby@ubuntu.com-20110520130718-db41dybbanzfvlji
Tags: 2.10.5-1ubuntu1
* Merge from Debian unstable, remaining changes:
  - Fix build failure with --no-add-needed.
  - Build for multiarch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2
 
.TH "gnutls_x509_crq_get_key_purpose_oid" 3 "2.8.6" "gnutls" "gnutls"
 
2
.TH "gnutls_x509_crq_get_key_purpose_oid" 3 "2.10.5" "gnutls" "gnutls"
3
3
.SH NAME
4
 
gnutls_x509_crq_get_key_purpose_oid \- get Certificate's key purpose OIDs
 
4
gnutls_x509_crq_get_key_purpose_oid \- API function
5
5
.SH SYNOPSIS
6
6
.B #include <gnutls/x509.h>
7
7
.sp
8
 
.BI "int gnutls_x509_crq_get_key_purpose_oid(gnutls_x509_crq_t " cert ", int " indx ", void * " oid ", size_t * " sizeof_oid ", unsigned int * " critical ");"
 
8
.BI "int gnutls_x509_crq_get_key_purpose_oid(gnutls_x509_crq_t " crq ", int " indx ", void * " oid ", size_t * " sizeof_oid ", unsigned int * " critical ");"
9
9
.SH ARGUMENTS
10
 
.IP "gnutls_x509_crq_t cert" 12
 
10
.IP "gnutls_x509_crq_t crq" 12
11
11
should contain a \fBgnutls_x509_crq_t\fP structure
12
12
.IP "int indx" 12
13
 
This specifies which OID to return. Use zero to get the first one.
 
13
This specifies which OID to return, use zero to get the first one
14
14
.IP "void * oid" 12
15
 
a pointer to a buffer to hold the OID (may be null)
 
15
a pointer to a buffer to hold the OID (may be \fBNULL\fP)
16
16
.IP "size_t * sizeof_oid" 12
17
17
initially holds the size of \fIoid\fP
18
18
.IP "unsigned int * critical" 12
19
 
output variable with critical flag, may be NULL.
 
19
output variable with critical flag, may be \fBNULL\fP.
20
20
.SH "DESCRIPTION"
21
21
This function will extract the key purpose OIDs of the Certificate
22
 
specified by the given index.  These are stored in the Extended
23
 
Key Usage extension (2.5.29.37).  See the GNUTLS_KP_* definitions
24
 
for human readable names.
25
 
 
26
 
If \fIoid\fP is null then only the size will be filled.
 
22
specified by the given index.  These are stored in the Extended Key
 
23
Usage extension (2.5.29.37).  See the GNUTLS_KP_* definitions for
 
24
human readable names.
27
25
.SH "RETURNS"
28
26
\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the provided buffer is
29
 
not long enough, and in that case the *sizeof_oid will be
 
27
not long enough, and in that case the *\fIsizeof_oid\fP will be
30
28
updated with the required size.  On success 0 is returned.
31
29
.SH "SINCE"
32
30
2.8.0