example.c File Reference

A simple demonstration of initialization, configuration, and basic usage of libsir. More...

Functions
int	report_error (void)
	Prints the last libsir error to stderr.
void	report_warning (const char *warning)
	Prints a warning message along with the last libsir error to stderr.
int	main (void)
	This is a basic example of initializing and configuring libsir for use.

Detailed Description

A simple demonstration of initialization, configuration, and basic usage of libsir.

Version

2.2.5

---

SPDX-License-Identifier: MIT

Copyright (c) 2018-2024 Ryan M. Lederman leder.nosp@m.man@.nosp@m.gmail.nosp@m..com Copyright (c) 2018-2024 Jeffrey H. Johnson trnsz.nosp@m.@pob.nosp@m.ox.co.nosp@m.m

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

main()

int main

(

void

)

This is a basic example of initializing and configuring libsir for use.

Note

You can build this command-line app yourself using make example or the Visual Studio [Code] project files.

When the program is finished running, you can see the output in the console, and examine the contents of 'libsir-example.log' in the current working directory.

Returns

EXIT_SUCCESS if execution completes successfully, or EXIT_FAILURE if an error occurs.

report_error()

int report_error

(

void

)

Prints the last libsir error to stderr.

Returns

EXIT_SUCCESS if execution completes successfully, or EXIT_FAILURE if an error occurs.

report_warning()

void report_warning

(

const char *

warning

)

Prints a warning message along with the last libsir error to stderr.

Parameters

warning

The warning message text.