SystemConfiguration.fproj/SCPRemove.c

   1 /*
   2  * Copyright(c) 2000-2003 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
  26 /*
  27  * Modification History
  28  *
  29  * June 1, 2001                 Allan Nathanson <ajn@apple.com>
  30  * - public API conversion
  31  *
  32  * November 9, 2000             Allan Nathanson <ajn@apple.com>
  33  * - initial revision
  34  */
  35
  36 #include <SystemConfiguration/SystemConfiguration.h>
  37 #include <SystemConfiguration/SCPrivate.h>
  38 #include "SCPreferencesInternal.h"
  39
  40 Boolean
  41 SCPreferencesRemoveValue(SCPreferencesRef session, CFStringRef key)
  42 {
  43         SCPreferencesPrivateRef sessionPrivate  = (SCPreferencesPrivateRef)session;
  44
  45         if (_sc_verbose) {
  46                 SCLog(TRUE, LOG_DEBUG, CFSTR("SCPreferencesRemoveValue:"));
  47                 SCLog(TRUE, LOG_DEBUG, CFSTR("  key = %@"), key);
  48         }
  49
  50         sessionPrivate->accessed = TRUE;
  51
  52         if (!CFDictionaryContainsKey(sessionPrivate->prefs, key)) {
  53                 _SCErrorSet(kSCStatusNoKey);
  54                 return FALSE;
  55         }
  56
  57         CFDictionaryRemoveValue(sessionPrivate->prefs, key);
  58         sessionPrivate->changed  = TRUE;
  59         return TRUE;
  60 }