libkern/libkern/c++/OSUnserialize.h

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