1 /*

     2 * Copyright (c) 2003 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of the License "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Provides a single header for the cXML Parser

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef _CXML_FILE_IF_H_

    21 #define _CXML_FILE_IF_H_

    22 

    23 #include <xml/cxml/cxml_proj.h>

    24 

    25 #ifdef __cplusplus

    26 extern "C" {

    27 #endif

    28 

    29   /** ----------------------------------------------------------------------- **

    30     @function:     CXML_File_Read

    31     @synopsis:    Read the contents from the file and store in a buffer.

    32     @scope:       public      

    33 

    34     @parameters: 

    35         [in] fileName

    36                   

    37 

    38         [out] CXML_Uint8* buf

    39                   Buffer to store the file contents and buffer need to freed from the

    40                   calling function.

    41 				  (-1): In case of error.

    42 

    43 

    44         [out] CXML_Uint32* bufferLen

    45                        Length of the Buffer        

    46 

    47     @description: Read contents from the file and store these in a buffer to be 

    48                          read by the cXML parser.

    49 

    50     @returns:   

    51                   In case of file  related failures:  Error codes is returned defined in 

    52 				                                      nwx_status.h

    53                   NW_STAT_FAILURE : For any general error.

    54                   NW_STAT_SUCCESS: For success

    55  -----------------------------------------------------------------------------------**/

    56 

    57 IMPORT_C

    58 NW_Status_t  CXML_Read_From_File(NW_Byte* fileName,NW_Uint8** buf, NW_Int32* bufferLen);

    59 

    60 #ifdef __cplusplus 

    61 } /* extern "C" { */

    62 #endif /* __cplusplus */

    63 

    64 #endif //_CXML_FILE_IF_H_