mirror of
https://github.com/libssh2/libssh2.git
synced 2025-04-20 13:47:45 +03:00
f6aa31f48f
- All files have prominent copyright and SPDX identifier - If not embedded in the file, in the .reuse/dep5 file - All used licenses are in LICENSES/ (not shipped in tarballs) - A new REUSE CI job verify that all files are OK Assisted-by: Viktor Szakats Closes #1084
48 lines
1.6 KiB
Groff
48 lines
1.6 KiB
Groff
.\" Copyright (C) Daniel Stenberg
|
|
.\" SPDX-License-Identifier: BSD-3-Clause
|
|
.TH libssh2_knownhost_writeline 3 "28 May 2009" "libssh2" "libssh2"
|
|
.SH NAME
|
|
libssh2_knownhost_writeline - convert a known host to a line for storage
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_knownhost_writeline(LIBSSH2_KNOWNHOSTS *hosts,
|
|
struct libssh2_knownhost *known,
|
|
char *buffer, size_t buflen,
|
|
size_t *outlen,
|
|
int type);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Converts a single known host to a single line of output for storage, using
|
|
the 'type' output format.
|
|
|
|
\fIknown\fP identifies which particular known host
|
|
|
|
\fIbuffer\fP points to an allocated buffer
|
|
|
|
\fIbuflen\fP is the size of the \fIbuffer\fP. See RETURN VALUE about the size.
|
|
|
|
\fIoutlen\fP 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!
|
|
|
|
\fItype\fP specifies what file type it is, and
|
|
\fILIBSSH2_KNOWNHOST_FILE_OPENSSH\fP is the only currently supported
|
|
format.
|
|
.SH 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
|
|
\fIoutlen\fP size will then hold the requested size.
|
|
.SH AVAILABILITY
|
|
Added in libssh2 1.2
|
|
.SH SEE ALSO
|
|
.BR libssh2_knownhost_get(3)
|
|
.BR libssh2_knownhost_readline(3)
|
|
.BR libssh2_knownhost_writefile(3)
|