gnutls_server_name_get(3)          gnutls          gnutls_server_name_get(3)

NAME         top

       gnutls_server_name_get - API function

SYNOPSIS         top

       #include <gnutls/gnutls.h>

       int gnutls_server_name_get(gnutls_session_t session, void * data,
       size_t * data_length, unsigned int * type, unsigned int indx);

ARGUMENTS         top

       gnutls_session_t session
                   is a gnutls_session_t type.

       void * data will hold the data

       size_t * data_length
                   will hold the data length. Must hold the maximum size of

       unsigned int * type
                   will hold the server name indicator type

       unsigned int indx
                   is the index of the server_name

DESCRIPTION         top

       This function will allow you to get the name indication (if any), a
       client has sent.  The name indication may be any of the enumeration

       If  type is GNUTLS_NAME_DNS, then this function is to be used by
       servers that support virtual hosting, and the data will be a null
       terminated IDNA ACE string (prior to GnuTLS 3.4.0 it was a UTF-8

       If  data has not enough size to hold the server name
       GNUTLS_E_SHORT_MEMORY_BUFFER is returned, and  data_length will hold
       the required size.

        indx is used to retrieve more than one server names (if sent by the
       client).  The first server name has an index of 0, the second 1 and
       so on.  If no name with the given index exists

RETURNS         top

       On success, GNUTLS_E_SUCCESS (0) is returned, on UTF-8 decoding error
       GNUTLS_E_IDNA_ERROR is returned, otherwise a negative error code is

REPORTING BUGS         top

       Report bugs to <>.
       Home page:

COPYRIGHT         top

       Copyright © 2001-2018 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         top

       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 

COLOPHON         top

       This page is part of the GnuTLS (GnuTLS Transport Layer Security
       Library) project.  Information about the project can be found at 
       ⟨⟩.  If you have a bug report for this manual
       page, send it to  This page was obtained from the
       tarball gnutls-3.6.2.tar.xz fetched from
       ⟨⟩ on 2018-04-30.  If you discover
       any rendering problems in this HTML version of the page, or you
       believe there is a better or more up-to-date source for the page, or
       you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page), send a mail

gnutls                              3.6.2          gnutls_server_name_get(3)