libkern/libkern/c++/OSUnserialize.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /* OSUnserialize.h created by rsulack on Mon 23-Nov-1998 */
  23
  24 #ifndef _OS_OSUNSERIALIZE_H
  25 #define _OS_OSUNSERIALIZE_H
  26
  27 #include <sys/appleapiopts.h>
  28
  29 class OSObject;
  30 class OSString;
  31
  32 /*! @function OSUnserializeXML
  33     @abstract Recreates an OS Container object from its previously serialized OS Container class instance data.
  34     @param buffer pointer to buffer containing XML data representing the object to be recreated.
  35     @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.
  36     @result Pointer to the recreated object, or zero on failure. */
  37
  38 extern OSObject* OSUnserializeXML(const char *buffer, OSString **errorString = 0);
  39
  40 #ifdef __APPLE_API_OBSOLETE
  41 extern OSObject* OSUnserialize(const char *buffer, OSString **errorString = 0);
  42 #endif /* __APPLE_API_OBSOLETE */
  43
  44 #endif /* _OS_OSUNSERIALIZE_H */