API: SPBckDbg.h Source File

00001 /***********************************************************************/
00002 /*                                                                     */
00003 /* SPBckDbg.h                                                          */
00004 /*                                                                     */
00005 /* ADOBE SYSTEMS INCORPORATED                                          */
00006 /* Copyright 1995-2007 Adobe Systems Incorporated.                     */
00007 /* All Rights Reserved.                                                */
00008 /*                                                                     */
00009 /* NOTICE:  Adobe permits you to use, modify, and distribute this file */
00010 /* in accordance with the terms of the Adobe license agreement         */
00011 /* accompanying it. If you have received this file from a source other */
00012 /* than Adobe, then your use, modification, or distribution of it      */
00013 /* requires the prior written permission of Adobe.                     */
00014 /*                                                                     */
00015 /* Patents Pending                                                     */
00016 /*                                                                     */
00017 /*                                                                     */
00018 /***********************************************************************/
00019 
00020 #ifndef __SPBlockDebug__
00021 #define __SPBlockDebug__
00022 
00023 
00024 /*******************************************************************************
00025  **
00026  **     Imports
00027  **
00028  **/
00029 
00030 #include "SPTypes.h"
00031 #include "AIBasicTypes.h"
00032 
00033 #include "SPHeaderBegin.h"
00034 
00035 #ifdef __cplusplus
00036 extern "C" {
00037 #endif
00038 
00039 
00040 /*******************************************************************************
00041  **
00042  **     Constants
00043  **
00044  **/
00046 #define kSPBlockDebugSuite                      "SP Block Debug Suite"
00047 
00048 #define kSPBlockDebugSuiteVersion       2
00049 
00050 
00051 /*******************************************************************************
00052  **
00053  **     Suite
00054  **
00055  **/
00056 
00065 typedef struct SPBlockDebugSuite {
00070         SPAPI SPErr (*GetBlockDebugEnabled)( ai::int32 *enabled );
00074         SPAPI SPErr (*SetBlockDebugEnabled)( ai::int32 debug );
00079         SPAPI SPErr (*GetFirstBlock)( void **block );
00085         SPAPI SPErr (*GetNextBlock)( void *block, void **nextblock );
00092         SPAPI SPErr (*GetBlockDebug)( void *block, const char **debug );
00093 
00094 } SPBlockDebugSuite;
00095 
00096 
00098 SPAPI SPErr SPGetBlockDebugEnabled( ai::int32 *enabled );
00100 SPAPI SPErr SPSetBlockDebugEnabled( ai::int32 debug );
00102 SPAPI SPErr SPGetFirstBlock( void **block );
00104 SPAPI SPErr SPGetNextBlock( void *block, void **nextblock );
00106 SPAPI SPErr SPGetBlockDebug( void *block, const char **debug );
00107 
00108 
00109 /*******************************************************************************
00110  **
00111  **     Errors
00112  **
00113  **/
00114 
00115 #include "SPErrorCodes.h"
00116 
00117 #ifdef __cplusplus
00118 }
00119 #endif
00120 
00121 #include "SPHeaderEnd.h"
00122 
00123 #endif