SystemConfiguration.fproj/SCPreferencesGetSpecificPrivate.h

   1 /*
   2  * Copyright (c) 2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_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. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #ifndef _SCPREFERENCESGETSPECIFICPRIVATE_H
  25 #define _SCPREFERENCESGETSPECIFICPRIVATE_H
  26
  27 #include <sys/cdefs.h>
  28 #include <CoreFoundation/CoreFoundation.h>
  29 #include <SystemConfiguration/SCPreferences.h>
  30
  31
  32 /*!
  33         @header SCPreferencesGetSpecificPrivate
  34         @discussion The functions in the SCPreferencesGetSpecificPrivate API allow
  35                 an application to get specific configuration information
  36                 about the current system (for example, the host name).
  37
  38                 To access configuration preferences, you must first establish
  39                 a preferences session using the SCPreferencesCreate function.
  40  */
  41
  42
  43 __BEGIN_DECLS
  44
  45 /*!
  46         @function SCPreferencesGetHostName
  47         @discussion Gets the host name preference.
  48         @param prefs The preferences session.
  49         @result name The host name to be set;
  50                 NULL if the name has not been set or if an error was encountered.
  51  */
  52 CFStringRef
  53 SCPreferencesGetHostName                (
  54                                         SCPreferencesRef        prefs
  55                                         );
  56
  57 __END_DECLS
  58
  59 #endif /* _SCPREFERENCESGETSPECIFICPRIVATE_H */