Blame doc/functions/gnutls_pkcs11_obj_get_info

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