xmlsrv_plat/cxml_library_api/inc/cxml_file_if.h
author hgs
Wed, 23 Jun 2010 20:27:15 +0530
changeset 24 74f0b3eb154c
permissions -rw-r--r--
201024
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
24
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2003 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of the License "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  Provides a single header for the cXML Parser
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
#ifndef _CXML_FILE_IF_H_
hgs
parents:
diff changeset
    21
#define _CXML_FILE_IF_H_
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
#include <xml/cxml/cxml_proj.h>
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
#ifdef __cplusplus
hgs
parents:
diff changeset
    26
extern "C" {
hgs
parents:
diff changeset
    27
#endif
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
  /** ----------------------------------------------------------------------- **
hgs
parents:
diff changeset
    30
    @function:     CXML_File_Read
hgs
parents:
diff changeset
    31
    @synopsis:    Read the contents from the file and store in a buffer.
hgs
parents:
diff changeset
    32
    @scope:       public      
hgs
parents:
diff changeset
    33
hgs
parents:
diff changeset
    34
    @parameters: 
hgs
parents:
diff changeset
    35
        [in] fileName
hgs
parents:
diff changeset
    36
                  
hgs
parents:
diff changeset
    37
hgs
parents:
diff changeset
    38
        [out] CXML_Uint8* buf
hgs
parents:
diff changeset
    39
                  Buffer to store the file contents and buffer need to freed from the
hgs
parents:
diff changeset
    40
                  calling function.
hgs
parents:
diff changeset
    41
				  (-1): In case of error.
hgs
parents:
diff changeset
    42
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
        [out] CXML_Uint32* bufferLen
hgs
parents:
diff changeset
    45
                       Length of the Buffer        
hgs
parents:
diff changeset
    46
hgs
parents:
diff changeset
    47
    @description: Read contents from the file and store these in a buffer to be 
hgs
parents:
diff changeset
    48
                         read by the cXML parser.
hgs
parents:
diff changeset
    49
hgs
parents:
diff changeset
    50
    @returns:   
hgs
parents:
diff changeset
    51
                  In case of file  related failures:  Error codes is returned defined in 
hgs
parents:
diff changeset
    52
				                                      nwx_status.h
hgs
parents:
diff changeset
    53
                  NW_STAT_FAILURE : For any general error.
hgs
parents:
diff changeset
    54
                  NW_STAT_SUCCESS: For success
hgs
parents:
diff changeset
    55
 -----------------------------------------------------------------------------------**/
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
IMPORT_C
hgs
parents:
diff changeset
    58
NW_Status_t  CXML_Read_From_File(NW_Byte* fileName,NW_Uint8** buf, NW_Int32* bufferLen);
hgs
parents:
diff changeset
    59
hgs
parents:
diff changeset
    60
#ifdef __cplusplus 
hgs
parents:
diff changeset
    61
} /* extern "C" { */
hgs
parents:
diff changeset
    62
#endif /* __cplusplus */
hgs
parents:
diff changeset
    63
hgs
parents:
diff changeset
    64
#endif //_CXML_FILE_IF_H_