sbgInterfaceFile.h File Reference

This file implements a file interface for read only operations. More...

#include <sbgCommon.h>
#include "sbgInterface.h"

Go to the source code of this file.

Functions
SBG_COMMON_LIB_API SbgErrorCode	sbgInterfaceFileOpen (SbgInterface *pInterface, const char *filePath)
SBG_COMMON_LIB_API SbgErrorCode	sbgInterfaceFileWriteOpen (SbgInterface *pInterface, const char *filePath)
SBG_COMMON_LIB_API size_t	sbgInterfaceFileGetSize (SbgInterface *pInterface)
SBG_COMMON_LIB_API size_t	sbgInterfaceFileGetCursor (const SbgInterface *pInterface)

Detailed Description

This file implements a file interface for read only operations.

Author

SBG Systems (Raphael Siryani)

Date

01 April 2013

Copyright

Copyright (C) 2022, SBG Systems SAS. All rights reserved.

License

The MIT license

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Function Documentation

sbgInterfaceFileOpen()

SBG_COMMON_LIB_API SbgErrorCode sbgInterfaceFileOpen	(	SbgInterface *	pInterface,
		const char *	filePath
	)

Open a file as an interface for read only operations.

Parameters

[in]	pInterface	Pointer on an allocated interface instance to initialize.
[in]	filePath	File path to open.

Returns

SBG_NO_ERROR if the interface has been created.

sbgInterfaceFileWriteOpen()

SBG_COMMON_LIB_API SbgErrorCode sbgInterfaceFileWriteOpen	(	SbgInterface *	pInterface,
		const char *	filePath
	)

Open a file as an interface for write only operations.

Parameters

[in]	pInterface	Pointer on an allocated interface instance to initialize.
[in]	filePath	File path to open.

Returns

SBG_NO_ERROR if the interface has been created.

sbgInterfaceFileGetSize()

SBG_COMMON_LIB_API size_t sbgInterfaceFileGetSize

(

SbgInterface *

pInterface

)

Returns the file size in bytes.

Parameters

[in]

pInterface

Valid handle on an initialized interface.

Returns

The file size in bytes.

sbgInterfaceFileGetCursor()

SBG_COMMON_LIB_API size_t sbgInterfaceFileGetCursor

(

const SbgInterface *

pInterface

)

Returns the current cursor position in the file in bytes.

Parameters

[in]

pInterface

Valid handle on an initialized interface.

Returns

The current cursor position in bytes.