OSX/libsecurity_transform/lib/SecCollectTransform.h

   1 #ifndef __SECCOLLECTTRANSFORM_H__
   2 #define __SECCOLLECTTRANSFORM_H__
   3
   4 /*
   5  * Copyright (c) 2010-2011 Apple Inc. All Rights Reserved.
   6  *
   7  * @APPLE_LICENSE_HEADER_START@
   8  *
   9  * This file contains Original Code and/or Modifications of Original Code
  10  * as defined in and that are subject to the Apple Public Source License
  11  * Version 2.0 (the 'License'). You may not use this file except in
  12  * compliance with the License. Please obtain a copy of the License at
  13  * http://www.opensource.apple.com/apsl/ and read it before using this
  14  * file.
  15  *
  16  * The Original Code and all software distributed under the License are
  17  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  18  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  19  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  21  * Please see the License for the specific language governing rights and
  22  * limitations under the License.
  23  *
  24  * @APPLE_LICENSE_HEADER_END@
  25  */
  26
  27 #include "SecTransform.h"
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33
  34 /*!
  35          @function                      SecCreateCollectTransform
  36          @abstract                      Creates a  collection object.
  37
  38
  39          @param error           A pointer to a CFErrorRef.  This pointer will be set
  40                                                 if an error occurred.  This value may be NULL if you
  41                                                 do not want an error returned.
  42          @result                        A pointer to a SecTransformRef object.  This object must
  43                                                 be released with CFRelease when you are done with
  44                                                 it.  This function will return NULL if an error
  45                                                 occurred.
  46
  47          @discussion            This function creates a transform will collect all
  48                                                 of the data given to it and output a single data
  49                                                 item
  50 */
  51
  52
  53 SecTransformRef SecCreateCollectTransform(CFErrorRef* error)
  54         __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_NA);
  55
  56 #ifdef __cplusplus
  57 }
  58 #endif
  59
  60 #endif // __SECCOLLECTTRANSFORM_H__