1/*---------------------------------------------------------------------------*
2 *  SR_Session.h  *
3 *                                                                           *
4 *  Copyright 2007, 2008 Nuance Communciations, Inc.                               *
5 *                                                                           *
6 *  Licensed under the Apache License, Version 2.0 (the 'License');          *
7 *  you may not use this file except in compliance with the License.         *
8 *                                                                           *
9 *  You may obtain a copy of the License at                                  *
10 *      http://www.apache.org/licenses/LICENSE-2.0                           *
11 *                                                                           *
12 *  Unless required by applicable law or agreed to in writing, software      *
13 *  distributed under the License is distributed on an 'AS IS' BASIS,        *
14 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
15 *  See the License for the specific language governing permissions and      *
16 *  limitations under the License.                                           *
17 *                                                                           *
18 *---------------------------------------------------------------------------*/
19
20#ifndef __SR_SESSION_H
21#define __SR_SESSION_H
22
23
24
25#include "ESR_ReturnCode.h"
26#include "SR_SessionPrefix.h"
27#include "ptypes.h"
28
29/**
30 * @addtogroup SR_SessionModule SR_Session API functions
31 * - SR_Session inherits from @ref ESR_SessionTypeModule "ESR_SessionType." As a consequence,
32 *   you may invoke any @ref ESR_SessionTypeModule "ESR_SessionType" functions on it.
33 *   For example: @ref ESR_SessionGetSize "ESR_SessionGetSize(size)" is legal
34 *
35 * @{
36 */
37
38/**
39 * Initializes the SREC session.
40 *
41 * @param filename File to read session information from
42 * @return ESR_OPEN_ERROR if file cannot be opened; ESR_READ_ERROR if file cannot be read;
43 * ESR_OUT_OF_MEMORY if system is out of memory
44 */
45SREC_SESSION_API ESR_ReturnCode SR_SessionCreate(const LCHAR* filename);
46
47/**
48 * Destroys the SREC session.
49 *
50 * @return ESR_SUCCESS
51 */
52SREC_SESSION_API ESR_ReturnCode SR_SessionDestroy(void);
53
54/**
55 * @}
56 */
57
58
59#endif /* __SR_SESSION_H */
60