OSX/libsecurity_transform/lib/SecDecodeTransform.h

   1 #ifndef __SECDECODETRANSFORM_H__
   2 #define __SECDECODETRANSFORM_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 "SecEncodeTransform.h"
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 CF_ASSUME_NONNULL_BEGIN
  34 CF_IMPLICIT_BRIDGING_ENABLED
  35
  36         /*!
  37          @constant kSecDecodeTypeAttribute
  38          Used with SecTransformGetAttribute to query the attribute type.
  39          Returns one of the strings defined in the previous section.
  40          */
  41
  42         extern const CFStringRef kSecDecodeTypeAttribute;
  43
  44         /*!
  45          @function SecDecodeTransformCreate
  46          @abstract                      Creates an decode computation object.
  47          @param DecodeType      The type of digest to decode.  You may pass NULL
  48          for this parameter, in which case an appropriate
  49          algorithm will be chosen for you.
  50          @param error           A pointer to a CFErrorRef.  This pointer will be set
  51          if an error occurred.  This value may be NULL if you
  52          do not want an error returned.
  53          @result                                A pointer to a SecTransformRef object.  This object must
  54          be released with CFRelease when you are done with
  55          it.  This function will return NULL if an error
  56          occurred.
  57          @discussion                    This function creates a transform which computes a
  58          decode.
  59          */
  60
  61         // See SecEncodeTransformCreate for encoding...
  62         __nullable
  63         SecTransformRef SecDecodeTransformCreate(CFTypeRef DecodeType,
  64                                                                                          CFErrorRef* error
  65                                                                                          )
  66         __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_NA);
  67
  68 CF_IMPLICIT_BRIDGING_DISABLED
  69 CF_ASSUME_NONNULL_END
  70
  71 #ifdef __cplusplus
  72 }
  73 #endif
  74
  75
  76 #endif