SystemConfiguration.fproj/SCPrivate.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
  23 #ifndef _SCPRIVATE_H
  24 #define _SCPRIVATE_H
  25
  26 #include <sys/cdefs.h>
  27
  28 #include <CoreFoundation/CoreFoundation.h>
  29
  30 #include <SystemConfiguration/SCDynamicStorePrivate.h>
  31 #include <SystemConfiguration/SCDynamicStoreSetSpecificPrivate.h>
  32
  33 #include <SystemConfiguration/SCPreferencesPrivate.h>
  34
  35 /* framework variables */
  36 extern Boolean  _sc_debug;      /* TRUE if debugging enabled */
  37 extern Boolean  _sc_verbose;    /* TRUE if verbose logging enabled */
  38 extern Boolean  _sc_log;        /* TRUE if SCLog() output goes to syslog */
  39
  40 __BEGIN_DECLS
  41
  42 /*!
  43         @function _SCErrorSet
  44         @discussion Returns a last SystemConfiguration.framework API error code.
  45         @result The last error encountered.
  46  */
  47 void            _SCErrorSet                     (int                    error);
  48
  49 /*
  50         @function SCLog
  51         @discussion Conditionally issue a log message.
  52         @param condition A boolean value indicating if the message should be logged
  53         @param level A syslog(3) logging priority.
  54         @param formatString The format string
  55         @result The specified message will be written to the system message
  56                 logger (See syslogd(8)).
  57  */
  58 void            SCLog                           (Boolean                condition,
  59                                                  int                    level,
  60                                                  CFStringRef            formatString,
  61                                                  ...);
  62
  63 /*
  64         @function SCPrint
  65         @discussion Conditionally issue a debug message.
  66         @param condition A boolean value indicating if the message should be written
  67         @param stream The output stream for the log message.
  68         @param formatString The format string
  69         @result The specified message will be written to the specified output
  70                 stream.
  71  */
  72 void            SCPrint                         (Boolean                condition,
  73                                                  FILE                   *stream,
  74                                                  CFStringRef            formatString,
  75                                                  ...);
  76
  77 __END_DECLS
  78
  79 #endif  /* _SCPRIVATE_H */