scp_server_file.h File Reference

File operations. More...

#include "scp/scp_server.h"

Go to the source code of this file.

Functions

error_t scpServerOpenFileForWriting (ScpServerSession *session, const char_t *filename, uint32_t mode, uint64_t size)
 Open a file for writing. More...
 
error_t scpServerOpenFileForReading (ScpServerSession *session)
 Open a file for reading. More...
 
error_t scpServerWriteData (ScpServerSession *session)
 Write data to the specified file. More...
 
error_t scpServerReadData (ScpServerSession *session)
 Read data from the specified file. More...
 

Detailed Description

File operations.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2019-2024 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneSSH Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
2.4.0

Definition in file scp_server_file.h.

Function Documentation

◆ scpServerOpenFileForReading()

error_t scpServerOpenFileForReading ( ScpServerSession session)

Open a file for reading.

Parameters
[in]sessionHandle referencing an SCP session
Returns
Error code

Definition at line 122 of file scp_server_file.c.

◆ scpServerOpenFileForWriting()

error_t scpServerOpenFileForWriting ( ScpServerSession session,
const char_t filename,
uint32_t  mode,
uint64_t  size 
)

Open a file for writing.

Parameters
[in]sessionHandle referencing an SCP session
[in]filenameNULL-terminating string that contains the filename
[in]modeFile access rights
[in]sizeSize of the file, in bytes
Returns
Error code

Definition at line 55 of file scp_server_file.c.

◆ scpServerReadData()

error_t scpServerReadData ( ScpServerSession session)

Read data from the specified file.

Parameters
[in]sessionHandle referencing an SCP session
Returns
error

Definition at line 291 of file scp_server_file.c.

◆ scpServerWriteData()

error_t scpServerWriteData ( ScpServerSession session)

Write data to the specified file.

Parameters
[in]sessionHandle referencing an SCP session
Returns
Error code

Definition at line 205 of file scp_server_file.c.