libkern/libkern/c++/OSUnserialize.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /* OSUnserialize.h created by rsulack on Mon 23-Nov-1998 */
  29
  30 #ifndef _OS_OSUNSERIALIZE_H
  31 #define _OS_OSUNSERIALIZE_H
  32
  33 #include <sys/appleapiopts.h>
  34
  35 class OSObject;
  36 class OSString;
  37
  38 /*!
  39  * @header
  40  *
  41  * @abstract
  42  * This header declares the <code>OSUnserializeXML</code> function.
  43  */
  44
  45
  46 /*!
  47  * @function OSUnserializeXML
  48  *
  49  * @abstract
  50  * Recreates an OSContainer object
  51  * from its previously serialized OSContainer class instance data.
  52  *
  53  * @param buffer      A buffer containing nul-terminated XML data
  54  *                    representing the object to be recreated.
  55  * @param errorString If non-</code>NULL</code>, and the XML parser
  56  *                    finds an error in <code>buffer</code>,
  57  *                    <code>*errorString</code> indicates the line number
  58  *                    and type of error encountered.
  59  *
  60  * @result
  61  * The recreated object, or <code>NULL</code> on failure.
  62  *
  63  * @discussion
  64  * <b>Not safe</b> to call in a primary interrupt handler.
  65  */
  66 extern OSObject * OSUnserializeXML(
  67     const char  * buffer,
  68     OSString   ** errorString = 0);
  69
  70 #ifdef __APPLE_API_OBSOLETE
  71 extern OSObject* OSUnserialize(const char *buffer, OSString **errorString = 0);
  72 #endif /* __APPLE_API_OBSOLETE */
  73
  74 #endif /* _OS_OSUNSERIALIZE_H */