shEnvironment.c File Reference

#include "shenvironment/shEnvironment.h"
#include <stdio.h>
#include <stdlib.h>
#include <memory.h>
#include <string.h>

Functions
uint8_t	shGetIniProperties (const char *ini_file_path, SmdFileHandle *p_ini_smd, ShIniProperties *p_ini_properties)
	Function to get INI properties from a file.
uint8_t	shGetApplicationProperties (const char *application_file_path, SmdFileHandle *p_application_smd, ShApplicationProperties *p_application_properties)
	Function to get application properties from a file.
uint8_t	shGetHostMemoryProperties (const char *host_memory_file_path, SmdFileHandle *p_host_memory_smd, ShHostMemoryProperties *p_host_memory_properties)
	Function to get host memory properties from a file.
uint8_t	shGetVulkanMemoryProperties (const char *vulkan_memory_file_path, SmdFileHandle *p_vulkan_memory_smd, ShVulkanMemoryProperties *p_vulkan_memory_properties)
	Function to get Vulkan memory properties from a file.
uint8_t	shGetSerialProperties (const char *serial_file_path, SmdFileHandle *p_serial_smd, ShSerialProperties *p_serial_properties)
	Retrieves serial properties from a specified file.
uint8_t	shGetSceneProperties (const char *scene_file_path, SmdFileHandle *p_scene_smd, ShSceneProperties *p_scene_properties)
	Retrieves scene properties from a specified file.

Function Documentation

shGetApplicationProperties()

uint8_t shGetApplicationProperties	(	const char *	application_file_path,
		SmdFileHandle *	p_application_smd,
		ShApplicationProperties *	p_application_properties
	)

Function to get application properties from a file.

This function retrieves application properties from the specified application file and initializes the corresponding structures.

Parameters

application_file_path	Path to the application file.
p_application_smd	Valid pointer to an SmdFileHandle structure for application properties.
p_application_properties	Pointer to the ShApplicationProperties structure to store the retrieved application properties.

Returns

1 on success, 0 on failure.

shGetHostMemoryProperties()

uint8_t shGetHostMemoryProperties	(	const char *	card_inputs_file_path,
		SmdFileHandle *	p_card_inputs_smd,
		ShHostMemoryProperties *	p_card_inputs_properties
	)

Function to get host memory properties from a file.

This function retrieves host memory properties from the specified card inputs file and initializes the corresponding structures.

Parameters

card_inputs_file_path	Path to the card inputs file.
p_card_inputs_smd	Pointer to an SmdFileHandle structure for host memory properties.
p_card_inputs_properties	Pointer to the ShHostMemoryProperties structure to store the retrieved host memory properties.

Returns

1 on success, 0 on failure.

shGetIniProperties()

uint8_t shGetIniProperties	(	const char *	ini_file_path,
		SmdFileHandle *	p_ini_smd,
		ShIniProperties *	p_ini_properties
	)

Function to get INI properties from a file.

This function retrieves INI properties from the specified INI file and initializes the corresponding structures.

Parameters

ini_file_path	Path to the INI file.
p_ini_smd	Pointer to an SmdFileHandle structure for INI properties.
p_ini_properties	Pointer to the ShIniProperties structure to store the retrieved INI properties.

Returns

1 on success, 0 on failure.

shGetSceneProperties()

uint8_t shGetSceneProperties	(	const char *	scene_file_path,
		SmdFileHandle *	p_scene_smd,
		ShSceneProperties *	p_scene_properties
	)

Retrieves scene properties from a specified file.

Parameters

scene_file_path	Path to the scene file.
p_scene_smd	Valid pointer to an SmdFileHandle structure for the scene.
p_scene_properties	Valid pointer to an ShSceneProperties structure.

Returns

1 on success, 0 on failure.

shGetSerialProperties()

uint8_t shGetSerialProperties	(	const char *	serial_file_path,
		SmdFileHandle *	p_serial_smd,
		ShSerialProperties *	p_serial_properties
	)

Retrieves serial properties from a specified file.

Parameters

serial_file_path	Path to the serial file.
p_serial_smd	Valid pointer to an SmdFileHandle structure for serial.
p_serial_properties	Valid pointer to an ShSerialProperties structure.

Returns

1 on success, 0 on failure.

shGetVulkanMemoryProperties()

uint8_t shGetVulkanMemoryProperties	(	const char *	vulkan_memory_file_path,
		SmdFileHandle *	p_vulkan_memory_smd,
		ShVulkanMemoryProperties *	p_vulkan_memory_properties
	)

Function to get Vulkan memory properties from a file.

This function retrieves Vulkan memory properties from the specified Vulkan memory file and initializes the corresponding structures.

Parameters

vulkan_memory_file_path	Path to the Vulkan memory file.
p_vulkan_memory_smd	Pointer to an SmdFileHandle structure for Vulkan memory properties.
p_vulkan_memory_properties	Pointer to the ShVulkanMemoryProperties structure to store the retrieved Vulkan memory properties.

Returns

1 on success, 0 on failure.