Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_knownhost_writeline (3ssh2)

Name

libssh2_knownhost_writeline - age

Synopsis

#include <libssh2.h>

libssh2_knownhost_writeline(LIBSSH2_KNOWNHOSTS *hosts,
struct libssh2_knownhost *known,
char *buffer, size_t buflen,
size_t *outlen,
int type);

Description

libssh2 manual                              libssh2_knownhost_writeline(3ssh2)



NAME
       libssh2_knownhost_writeline  - convert a known host to a line for stor-
       age

SYNOPSIS
       #include <libssh2.h>

       libssh2_knownhost_writeline(LIBSSH2_KNOWNHOSTS *hosts,
                                   struct libssh2_knownhost *known,
                                   char *buffer, size_t buflen,
                                   size_t *outlen,
                                   int type);

DESCRIPTION
       Converts a single known host to a single line of  output  for  storage,
       using the 'type' output format.

       known identifies which particular known host

       buffer points to an allocated buffer

       buflen is the size of the buffer. See RETURN VALUE about the size.

       outlen  must be a pointer to a size_t variable that will get the output
       length of the stored data chunk.  The  number  does  not  included  the
       trailing zero!

       type specifies what file type it is, and LIBSSH2_KNOWNHOST_FILE_OPENSSH
       is the only currently supported format.

RETURN VALUE
       Returns a regular libssh2 error code, where negative values  are  error
       codes and 0 indicates success.

       If  the  provided  buffer  is  deemed too small to fit the data libssh2
       wants to store in it, LIBSSH2_ERROR_BUFFER_TOO_SMALL will be  returned.
       The  application  is  then  advised  to  call the function again with a
       larger buffer. The outlen size will then hold the requested size.

AVAILABILITY
       Added in libssh2 1.2


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libssh2  |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       libssh2_knownhost_get(3)  libssh2_knownhost_readline(3)  libssh2_known-
       host_writefile(3)




NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source   was   downloaded  from   https://www.libssh2.org/download/lib-
       ssh2-1.10.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.libssh2.org/.



libssh2 1.2                       28 May 2009
                                            libssh2_knownhost_writeline(3ssh2)