Blame doc/functions/gnutls_pkcs11_obj_get_info

Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
@deftypefun {int} {gnutls_pkcs11_obj_get_info} (gnutls_pkcs11_obj_t @var{obj}, gnutls_pkcs11_obj_info_t @var{itype}, void * @var{output}, size_t * @var{output_size})
Packit Service 4684c1
@var{obj}: should contain a @code{gnutls_pkcs11_obj_t}  type
Packit Service 4684c1
Packit Service 4684c1
@var{itype}: Denotes the type of information requested
Packit Service 4684c1
Packit Service 4684c1
@var{output}: where output will be stored
Packit Service 4684c1
Packit Service 4684c1
@var{output_size}: contains the maximum size of the output buffer and will be
Packit Service 4684c1
overwritten with the actual size.
Packit Service 4684c1
Packit Service 4684c1
This function will return information about the PKCS11 certificate
Packit Service 4684c1
such as the label, id as well as token information where the key is
Packit Service 4684c1
stored.
Packit Service 4684c1
Packit Service 4684c1
When output is text, a null terminated string is written to  @code{output} and its
Packit Service 4684c1
string length is written to  @code{output_size} (without null terminator). If the
Packit Service 4684c1
buffer is too small,  @code{output_size} will contain the expected buffer size
Packit Service 4684c1
(with null terminator for text) and return @code{GNUTLS_E_SHORT_MEMORY_BUFFER} .
Packit Service 4684c1
Packit Service 4684c1
In versions previously to 3.6.0 this function included the null terminator
Packit Service 4684c1
to  @code{output_size} . After 3.6.0 the output size doesn't include the terminator character.
Packit Service 4684c1
Packit Service 4684c1
@strong{Returns:} @code{GNUTLS_E_SUCCESS}  (0) on success or a negative error code on error.
Packit Service 4684c1
Packit Service 4684c1
@strong{Since:} 2.12.0
Packit Service 4684c1
@end deftypefun