libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_sftp_last_error 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_sftp_last_error - return the last SFTP-specific error code
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9
#include <libssh2_sftp.h>
10

11
unsigned long
12
libssh2_sftp_last_error(LIBSSH2_SFTP *sftp);
13
.fi
14
.SH DESCRIPTION
15
\fIsftp\fP - SFTP instance as returned by
16
.BR libssh2_sftp_init(3)
17

18
Returns the last error code produced by the SFTP layer. Note that this only
19
returns a sensible error code if libssh2 returned LIBSSH2_ERROR_SFTP_PROTOCOL
20
in a previous call. Using \fBlibssh2_sftp_last_error(3)\fP without a
21
preceding SFTP protocol error, it will return an unspecified value.
22
.SH RETURN VALUE
23
Current error code state of the SFTP instance.
24
.SH SEE ALSO
25
.BR libssh2_sftp_init(3)
26