libssh2_knownhost_writeline.3 (1624B)
1.\" 2.\" Copyright (c) 2009 by Daniel Stenberg 3.\" 4.TH libssh2_knownhost_writeline 3 "28 May 2009" "libssh2" "libssh2" 5.SH NAME 6libssh2_knownhost_writeline - convert a known host to a line for storage 7.SH SYNOPSIS 8.nf 9#include <libssh2.h> 10 11int 12libssh2_knownhost_writeline(LIBSSH2_KNOWNHOSTS *hosts, 13 struct libssh2_knownhost *known, 14 char *buffer, size_t buflen, 15 size_t *outlen, 16 int type); 17.fi 18.SH DESCRIPTION 19Converts a single known host to a single line of output for storage, using 20the 'type' output format. 21 22\fIknown\fP identifies which particular known host 23 24\fIbuffer\fP points to an allocated buffer 25 26\fIbuflen\fP is the size of the \fIbuffer\fP. See RETURN VALUE about the size. 27 28\fIoutlen\fP must be a pointer to a size_t variable that will get the output 29length of the stored data chunk. The number does not included the trailing 30zero! 31 32\fItype\fP specifies what file type it is, and 33\fILIBSSH2_KNOWNHOST_FILE_OPENSSH\fP is the only currently supported 34format. 35.SH RETURN VALUE 36Returns a regular libssh2 error code, where negative values are error codes 37and 0 indicates success. 38 39If the provided buffer is deemed too small to fit the data libssh2 wants to 40store in it, LIBSSH2_ERROR_BUFFER_TOO_SMALL will be returned. The application 41is then advised to call the function again with a larger buffer. The 42\fIoutlen\fP size will then hold the requested size. 43.SH AVAILABILITY 44Added in libssh2 1.2 45.SH SEE ALSO 46.BR libssh2_knownhost_get(3) 47.BR libssh2_knownhost_readline(3) 48.BR libssh2_knownhost_writefile(3)