Security-57336.1.9.tar.gz

[apple/security.git] / OSX / libsecurity_keychain / lib / SecKeychainSearchPriv.h

diff --git a/OSX/libsecurity_keychain/lib/SecKeychainSearchPriv.h b/OSX/libsecurity_keychain/lib/SecKeychainSearchPriv.h
new file mode 100644 (file)
index 0000000..6d907fd
--- /dev/null
+++ b/OSX/libsecurity_keychain/lib/SecKeychainSearchPriv.h
@@ -0,0 +1,57 @@
+/*
+ * Copyright (c) 2000-2011 Apple Inc. All Rights Reserved.
+ * 
+ * @APPLE_LICENSE_HEADER_START@
+ * 
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this
+ * file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ * 
+ * @APPLE_LICENSE_HEADER_END@
+ */
+
+/*!
+       @header SecKeychainSearchPriv
+       The functions provided in SecKeychainSearchPriv implement a query of one or more keychains to search for a particular SecKeychainItem.
+*/
+
+#ifndef _SECURITY_SecKeychainSearchPriv_H_
+#define _SECURITY_SecKeychainSearchPriv_H_
+
+#include <Security/SecKeychainItem.h>
+
+
+#if defined(__cplusplus)
+extern "C" {
+#endif
+
+/*!
+       @function SecKeychainSearchPrivCreateFromAttributesExtended
+       @abstract Creates a search reference matching a list of zero or more specified attributes in the specified keychain.
+    @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.
+       @param itemClass The keychain item class.
+       @param attrList A pointer to a list of zero or more keychain attribute records to match.  Pass NULL to match any keychain attribute.
+       @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.
+    @result A result code.  See "Security Error Codes" (SecBase.h).
+       @discussion This function is deprecated in Mac OS X 10.7 and later;
+       to find one or more keychain items which match specified attributes, use the SecItemCopyMatching API (see SecItem.h).
+*/
+OSStatus SecKeychainSearchCreateFromAttributesExtended(CFTypeRef keychainOrArray, SecItemClass itemClass, const SecKeychainAttributeList *attrList, CSSM_DB_CONJUNCTIVE dbConjunctive, CSSM_DB_OPERATOR dbOperator, SecKeychainSearchRef *searchRef)
+       DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
+
+#if defined(__cplusplus)
+}
+#endif
+
+#endif /* !_SECURITY_SecKeychainSearchPriv_H_ */