libkern/libkern/c++/OSUnserialize.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /* OSUnserialize.h created by rsulack on Mon 23-Nov-1998 */
  31
  32 #ifndef _OS_OSUNSERIALIZE_H
  33 #define _OS_OSUNSERIALIZE_H
  34
  35 #include <sys/appleapiopts.h>
  36
  37 class OSObject;
  38 class OSString;
  39
  40 /*! @function OSUnserializeXML
  41     @abstract Recreates an OS Container object from its previously serialized OS Container class instance data.
  42     @param buffer pointer to buffer containing XML data representing the object to be recreated.
  43     @param errorString if this is a valid pointer and the XML parser finds a error in buffer, errorString contains text indicating the line number and type of error encountered.
  44     @result Pointer to the recreated object, or zero on failure. */
  45
  46 extern OSObject* OSUnserializeXML(const char *buffer, OSString **errorString = 0);
  47
  48 #ifdef __APPLE_API_OBSOLETE
  49 extern OSObject* OSUnserialize(const char *buffer, OSString **errorString = 0);
  50 #endif /* __APPLE_API_OBSOLETE */
  51
  52 #endif /* _OS_OSUNSERIALIZE_H */