OSX/libsecurity_keychain/lib/SecKeychainSearchPriv.h

   1 /*
   2  * Copyright (c) 2000-2011 Apple 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 /*!
  25         @header SecKeychainSearchPriv
  26         The functions provided in SecKeychainSearchPriv implement a query of one or more keychains to search for a particular SecKeychainItem.
  27 */
  28
  29 #ifndef _SECURITY_SecKeychainSearchPriv_H_
  30 #define _SECURITY_SecKeychainSearchPriv_H_
  31
  32 #include <Security/SecKeychainItem.h>
  33
  34
  35 #if defined(__cplusplus)
  36 extern "C" {
  37 #endif
  38
  39 /*!
  40         @function SecKeychainSearchPrivCreateFromAttributesExtended
  41         @abstract Creates a search reference matching a list of zero or more specified attributes in the specified keychain.
  42     @param keychainOrArray An reference to an array of keychains to search, a single keychain or NULL to search the user's default keychain search list.
  43         @param itemClass The keychain item class.
  44         @param attrList A pointer to a list of zero or more keychain attribute records to match.  Pass NULL to match any keychain attribute.
  45         @param searchRef On return, a pointer to the current search reference. You are responsible for calling the CFRelease function to release this reference when finished with it.
  46     @result A result code.  See "Security Error Codes" (SecBase.h).
  47         @discussion This function is deprecated in Mac OS X 10.7 and later;
  48         to find one or more keychain items which match specified attributes, use the SecItemCopyMatching API (see SecItem.h).
  49 */
  50 OSStatus SecKeychainSearchCreateFromAttributesExtended(CFTypeRef keychainOrArray, SecItemClass itemClass, const SecKeychainAttributeList *attrList, CSSM_DB_CONJUNCTIVE dbConjunctive, CSSM_DB_OPERATOR dbOperator, SecKeychainSearchRef *searchRef)
  51         CSSM_DEPRECATED;
  52
  53 #if defined(__cplusplus)
  54 }
  55 #endif
  56
  57 #endif /* !_SECURITY_SecKeychainSearchPriv_H_ */