sftp_server_directory.h
Go to the documentation of this file.
1 /**
2  * @file sftp_server_directory.h
3  * @brief Directory operations
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2019-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneSSH Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.4.0
29  **/
30 
31 #ifndef _SFTP_SERVER_DIRECTORY_H
32 #define _SFTP_SERVER_DIRECTORY_H
33 
34 //Dependencies
35 #include "sftp/sftp_server.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //SFTP server related functions
44  const SshString *path, const SftpFileAttrs *attributes);
45 
47  const SshString *path);
48 
50  const SshString *path, uint32_t *handle);
51 
53  const SshBinaryString *handle, SftpName *name);
54 
56  const SshBinaryString *handle);
57 
59  const SshBinaryString *handle);
60 
61 //C++ guard
62 #ifdef __cplusplus
63 }
64 #endif
65 
66 #endif
error_t
Error codes.
Definition: error.h:43
uint8_t attributes[]
Definition: radius.h:88
char_t name[]
SFTP server.
#define SftpServerSession
Definition: sftp_server.h:120
error_t sftpServerOpenDir(SftpServerSession *session, const SshString *path, uint32_t *handle)
Open a directory.
error_t sftpServerReadDir(SftpServerSession *session, const SshBinaryString *handle, SftpName *name)
Read an entry from the specified directory.
SftpFileObject * sftpServerFindDir(SftpServerSession *session, const SshBinaryString *handle)
Find the directory object that matches a given handle.
error_t sftpServerCloseDir(SftpServerSession *session, const SshBinaryString *handle)
Close a directory.
error_t sftpServerRemoveDir(SftpServerSession *session, const SshString *path)
Remove a directory.
error_t sftpServerCreateDir(SftpServerSession *session, const SshString *path, const SftpFileAttrs *attributes)
Create a directory.
File attributes.
Definition: sftp_common.h:247
File or directory object.
Definition: sftp_server.h:186
Name structure.
Definition: sftp_common.h:265
Binary string.
Definition: ssh_types.h:67
String.
Definition: ssh_types.h:56