This Code Implements The OpEN APIs For STM Templates [OPENAPI_STM]

Macros
#define	OPEN_STM_TEMPLATE_DESCRIPTION_SIZE   80
#define	OPEN_STM_TEMPLATE_NAME_SIZE   16

Functions
open_error_t	openapiStmActiveTemplateIdGet (openapiClientHandle_t *client_handle, uint32_t *templateId)
	Gets current active Template Id. More...
open_error_t	openapiStmActiveTemplateIdSet (openapiClientHandle_t *client_handle, uint32_t templateId)
	Sets active template id. More...
open_error_t	openapiStmFirstTemplateIdGet (openapiClientHandle_t *client_handle, uint32_t *firstTemplateId)
	Get the first valid template ID. More...
open_error_t	openapiStmNextTemplateIdGet (openapiClientHandle_t *client_handle, uint32_t currentTemplateId, uint32_t *nextTemplateId)
	Get the next valid template ID. More...
open_error_t	openapiStmTemplateNameDescriptionGet (openapiClientHandle_t *client_handle, uint32_t templateId, open_buffdesc *templateName, open_buffdesc *templateDesc)
	Gets name and description of specific template id. More...
open_error_t	openapiStmTemplateRevertToDefault (openapiClientHandle_t *client_handle)
	Sets(Revert to) Default template. More...

Detailed Description

Function Documentation

open_error_t openapiStmActiveTemplateIdGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	templateId
	)

Gets current active Template Id.

Parameters

[in]	client_handle	client handle from registration API
[out]	templateId	STM template ID

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

stm_example.c.

open_error_t openapiStmActiveTemplateIdSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	templateId
	)

Sets active template id.

Parameters

[in]	client_handle	client handle from registration API
[in]	templateId	STM template ID

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_UNAVAIL	If STM template is not supported.
OPEN_E_EXISTS	If STM template is already configured.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.25

Examples:

stm_example.c.

open_error_t openapiStmFirstTemplateIdGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	firstTemplateId
	)

Get the first valid template ID.

Parameters

[in]	client_handle	client handle from registration API
[out]	firstTemplateId	First valid STM template ID

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

stm_example.c.

open_error_t openapiStmNextTemplateIdGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	currentTemplateId,
		uint32_t *	nextTemplateId
	)

Get the next valid template ID.

Parameters

[in]	client_handle	client handle from registration API
[in]	currentTemplateId	Current STM template ID
[out]	nextTemplateId	Next valid STM template ID

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

stm_example.c.

open_error_t openapiStmTemplateNameDescriptionGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	templateId,
		open_buffdesc *	templateName,
		open_buffdesc *	templateDesc
	)

Gets name and description of specific template id.

Parameters

[in]	client_handle	client handle from registration API
[in]	templateId	Template ID
[out]	templateName	Template name
[out]	templateDesc	Template Description

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

stm_example.c.

open_error_t openapiStmTemplateRevertToDefault

(

openapiClientHandle_t *

client_handle

)

Sets(Revert to) Default template.

Parameters

[in]

client_handle

client handle from registration API

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

stm_example.c.