rtEXIEventCode.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2008 Objective Systems, Inc.
00003  *
00004  * This software is furnished under a license and may be used and copied
00005  * only in accordance with the terms of such license and with the
00006  * inclusion of the above copyright notice. This software or any other
00007  * copies thereof may not be provided or otherwise made available to any
00008  * other person. No title to and ownership of the software is hereby
00009  * transferred.
00010  *
00011  * The information in this software is subject to change without notice
00012  * and should not be construed as a commitment by Objective Systems, Inc.
00013  *
00014  * PROPRIETARY NOTICE
00015  *
00016  * This software is an unpublished work subject to a confidentiality agreement
00017  * and is protected by copyright and trade secret law.  Unauthorized copying,
00018  * redistribution or other use of this work is prohibited.
00019  *
00020  * The above notice of copyright on this source code product does not indicate
00021  * any actual or intended publication of such source code.
00022  *
00023  *****************************************************************************/
00031 #ifndef _RTEXIEVENTCODE_H_
00032 #define _RTEXIEVENTCODE_H_
00033 
00034 #include "rtexisrc/rtEXIExternDefs.h"
00035 #include "rtxsrc/rtxContext.h"
00036 
00037 #ifdef __cplusplus
00038 extern "C" {
00039 #endif
00040 
00047 typedef struct OSEXIEventCode {
00048    OSINT32 part1;
00049    OSINT32 part2;
00050    OSINT32 part3;
00051 } OSEXIEventCode;
00052 
00053 /* Event code constants */
00054 extern const OSEXIEventCode gc_EC_0;
00055 extern const OSEXIEventCode gc_EC_0_0;
00056 extern const OSEXIEventCode gc_EC_0_1;
00057 extern const OSEXIEventCode gc_EC_0_2;
00058 extern const OSEXIEventCode gc_EC_0_3;
00059 extern const OSEXIEventCode gc_EC_0_4;
00060 extern const OSEXIEventCode gc_EC_0_5;
00061 extern const OSEXIEventCode gc_EC_0_6_0;
00062 extern const OSEXIEventCode gc_EC_0_6_1;
00063 extern const OSEXIEventCode gc_EC_1_0;
00064 extern const OSEXIEventCode gc_EC_1_1;
00065 extern const OSEXIEventCode gc_EC_1_2;
00066 extern const OSEXIEventCode gc_EC_1_1_0;
00067 extern const OSEXIEventCode gc_EC_1_1_1;
00068 extern const OSEXIEventCode gc_EC_1_3_0;
00069 extern const OSEXIEventCode gc_EC_1_3_1;
00070 extern const OSEXIEventCode gc_EC_2_0;
00071 
00081 EXTERNEXI int rtEXIEventCodeCompare 
00082 (const OSEXIEventCode* pec1, const OSEXIEventCode* pec2);
00083 
00094 EXTERNEXI OSEXIEventCode* 
00095 rtEXIEventCodeCopy (OSCTXT* pctxt, const OSEXIEventCode* pec);
00096 
00106 EXTERNEXI OSBOOL rtEXIEventCodesEqual
00107 (const OSEXIEventCode* pec1, const OSEXIEventCode* pec2);
00108 
00120 EXTERNEXI char* rtEXIEventCodeToString 
00121 (OSCTXT* pctxt, const OSEXIEventCode* pec);
00122 
00129 EXTERNEXI OSUINT32 rtEXIEventCodeLength (const OSEXIEventCode* pec);
00130 
00139 EXTERNEXI OSEXIEventCode* rtEXINewEventCode1 (OSCTXT* pctxt, OSINT32 part1);
00140 
00150 EXTERNEXI OSEXIEventCode* rtEXINewEventCode2 
00151 (OSCTXT* pctxt, OSINT32 part1, OSINT32 part2);
00152 
00163 EXTERNEXI OSEXIEventCode* rtEXINewEventCode3 
00164 (OSCTXT* pctxt, OSINT32 part1, OSINT32 part2, OSINT32 part3);
00165 
00172 #define rtEXISetEventCode1(pEventCode,part1) \
00173 rtEXISetEventCode3(pEventCode, part1, OSINT32_MIN, OSINT32_MIN)
00174 
00182 #define rtEXISetEventCode2(pEventCode,part1,part2) \
00183 rtEXISetEventCode3(pEventCode, part1, part2, OSINT32_MIN)
00184 
00193 EXTERNEXI void rtEXISetEventCode3 
00194 (OSEXIEventCode* pEventCode, OSINT32 part1, OSINT32 part2, OSINT32 part3);
00195 
00196 #ifndef _COMPACT
00197 
00202 EXTERNEXI void rtEXIEventCodePrint (const OSEXIEventCode* pEventCode);
00203 #endif
00204 
00205 #ifdef __cplusplus
00206 }
00207 #endif
00208 
00211 #endif