1 /*

     2 * Copyright (c) 2000 - 2001 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: 

    15 *

    16 */

    17 

    18 

    19 /** ----------------------------------------------------------------------- **

    20     @package:     NW_WBXML

    21 

    22     @synopsis:    default

    23 

    24     @description: Wbxml token definitions

    25 

    26  ** ----------------------------------------------------------------------- **/

    27 

    28 #ifndef NW_PARSER_WBXML_OPAQUE_H

    29 #define NW_PARSER_WBXML_OPAQUE_H

    30 

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

    32 

    33 #ifdef __cplusplus

    34 extern "C" {

    35 #endif /* __cplusplus */

    36 

    37 

    38 /** ----------------------------------------------------------------------- **

    39     @struct:      NW_WBXML_Opaque

    40 

    41     @synopsis:    WBXML opaque data.

    42 

    43     @scope:       public

    44     @variables:

    45        NW_Uint32 length

    46                   Data length.

    47 

    48        NW_Byte* data

    49                   Data.

    50 

    51     @description: WBXML opaque data.

    52  ** ----------------------------------------------------------------------- **/

    53 typedef struct NW_WBXML_Opaque_s {

    54   NW_Uint32 length;

    55   NW_Byte* data;

    56 } NW_WBXML_Opaque_t;

    57 

    58 

    59 /** ----------------------------------------------------------------------- **

    60     @function:    NW_WBXML_Opaque_new

    61 

    62     @synopsis:    Constructor.

    63 

    64     @scope:       public

    65 

    66     @description: Constructor.

    67 

    68     @returns:     NW_WBXML_Opaque_t*

    69                   Pointer to empty structure.

    70 

    71  ** ----------------------------------------------------------------------- **/

    72 NW_WBXML_Opaque_t* NW_WBXML_Opaque_new (void);

    73 

    74 

    75 /** ----------------------------------------------------------------------- **

    76     @function:    NW_WBXML_Opaque_delete

    77 

    78     @synopsis:    Destructor.

    79 

    80     @scope:       public

    81 

    82     @parameters:

    83        [in-out] NW_WBXML_Opaque_t* opaque

    84                   The opaque data.

    85 

    86     @description: Destructor. Deletes the opaque structure. The referenced

    87                   memory is not deleted.

    88 

    89     @returns:     NW_Status_t

    90                   Status of operation.

    91 

    92        [NW_STAT_SUCCESS]

    93                   Always returns success.

    94 

    95  ** ----------------------------------------------------------------------- **/

    96 NW_Status_t NW_WBXML_Opaque_delete (NW_WBXML_Opaque_t* opaque);

    97 

    98 

    99 /** ----------------------------------------------------------------------- **

   100     @function:    NW_WBXML_Opaque_construct

   101 

   102     @synopsis:    Constructor.

   103 

   104     @scope:       public

   105 

   106     @parameters:

   107        [in-out] NW_WBXML_Opaque_t* opaque

   108                   Structure created with the "New".

   109 

   110        [in] NW_Byte* data

   111                   Opaque data.

   112 

   113        [in] NW_Uint32 length

   114                   Length of data.

   115 

   116     @description: Constructor. Initializes a structure created with the "New".

   117                   This is really an initializer, not a constructor in the C++ 

   118                   or Java sense.

   119 

   120     @returns:     NW_Status_t

   121                   default

   122 

   123  ** ----------------------------------------------------------------------- **/

   124 NW_Status_t NW_WBXML_Opaque_construct (NW_WBXML_Opaque_t* opaque, 

   125                                        NW_Byte* data, 

   126                                        NW_Uint32 length);

   127 #ifdef __cplusplus

   128 } /* extern "C" { */

   129 #endif /* __cplusplus */

   130 

   131 #endif  /* NW_PARSER_WBXML_OPAQUE_H */