This file implements SbgECom commands related to settings. More...
#include "sbgEComCmdCommon.h"
Go to the source code of this file.
Typedefs | |
typedef enum _SbgEComSettingsAction | SbgEComSettingsAction |
Enumerations | |
enum | _SbgEComSettingsAction { SBG_ECOM_REBOOT_ONLY = 0, SBG_ECOM_SAVE_SETTINGS = 1, SBG_ECOM_RESTORE_DEFAULT_SETTINGS = 2 } |
Functions | |
SbgErrorCode | sbgEComCmdExportSettings (SbgEComHandle *pHandle, void *pBuffer, size_t *pSize, size_t maxSize) |
SbgErrorCode | sbgEComCmdImportSettings (SbgEComHandle *pHandle, const void *pBuffer, size_t size) |
SbgErrorCode | sbgEComCmdSettingsAction (SbgEComHandle *pHandle, SbgEComSettingsAction action) |
This file implements SbgECom commands related to settings.
Copyright (C) 2007-2013, SBG Systems SAS. All rights reserved.
This source code is intended for use only by SBG Systems SAS and those that have explicit written permission to use it from SBG Systems SAS.
THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
Definition in file sbgEComCmdSettings.h.
typedef enum _SbgEComSettingsAction SbgEComSettingsAction |
Defintion of all the settings actions available.
Defintion of all the settings actions available.
Definition at line 32 of file sbgEComCmdSettings.h.
SbgErrorCode sbgEComCmdExportSettings | ( | SbgEComHandle * | pHandle, |
void * | pBuffer, | ||
size_t * | pSize, | ||
size_t | maxSize | ||
) |
Retrieve a complete set of settings from the device as a buffer.
[in] | pHandle | A valid sbgECom handle. |
[in] | pBuffer | Allocated buffer that can hold the received settings. |
[out] | pSize | The number of bytes that have been stored into pBuffer. |
[in] | maxSize | The maximum buffer size in bytes that can be stored into pBuffer. |
Definition at line 96 of file sbgEComCmdSettings.c.
SbgErrorCode sbgEComCmdImportSettings | ( | SbgEComHandle * | pHandle, |
const void * | pBuffer, | ||
size_t | size | ||
) |
Send a complete set of settings to the device and store them into the FLASH memory. The device will reboot automatically to use the new settings.
[in] | pHandle | A valid sbgECom handle. |
[in] | pBuffer | Read only buffer containing the settings. |
[in] | size | Size of the buffer. |
Definition at line 80 of file sbgEComCmdSettings.c.
SbgErrorCode sbgEComCmdSettingsAction | ( | SbgEComHandle * | pHandle, |
SbgEComSettingsAction | action | ||
) |
Execute one of the available settings action :
[in] | pHandle | A valid sbgECom handle. |
[in] | action | One of the available SbgEComSettingsAction. |
Definition at line 18 of file sbgEComCmdSettings.c.