C:/AudioFramework/Core/AFMessages.h File Reference

The error reporting system and the debugging macros live here. More...

#include <stdio.h>
#include <stdarg.h>

Go to the source code of this file.

Defines

#define AF_DISABLE   0
#define AF_TRACE   1
#define AF_DEBUG   2
#define AF_ERROR   3
#define AF_OUTPUT   4
#define AF_WARN   AF_DISABLE
#define AF_INCLUDE_CODE   0
#define INCLUDE_CODE(statement)
#define AF_SUCCESS(__status__)   (AFS_RETURN_BASE == ((__status__) & 0xffff0000))
#define AF_FAILURE(__status__)   (!AF_SUCCESS((__status__)))
#define AF_STRINGIFY(__err__)   #__err__
#define AF_DUMMY_INIT   (PVOID)0xAFC0FFEE

Enumerations

enum  AF_STATUS {
  AFS_RETURN_BASE = 0xbbbb0000, AFS_SUCCESS = AFS_RETURN_BASE + 0, AFS_ERROR_BASE = 0xcccc0000, AFS_FAILURE = AFS_ERROR_BASE + 1,
  AFS_DATA_TIMED_OUT = AFS_ERROR_BASE + 2, AFS_NOT_IMPLEMENTED = AFS_ERROR_BASE + 3, AFS_INVALID_PARAMETER = AFS_ERROR_BASE + 4, AFS_OUTOFMEMORY = AFS_ERROR_BASE + 5,
  AFS_IOCONTROL_FAILED = AFS_ERROR_BASE + 6
}

Functions

void AF_MSG (int type, const char *fmt,...)
 Print a message to standard output.
void DoSetLastError (AF_STATUS retval)
 Given a AF_STATUS value set the corresponding system error using SetLastError.

Detailed Description

The error reporting system and the debugging macros live here.

Version:
$Id: AFMessages.h 2041 2009-07-27 12:37:46Z mz $
Author:
Dimitris Papastamos
Manfredas Zabarauskas

Definition in file AFMessages.h.


Define Documentation

#define AF_DEBUG   2

Definition at line 49 of file AFMessages.h.

#define AF_DISABLE   0

Definition at line 46 of file AFMessages.h.

#define AF_DUMMY_INIT   (PVOID)0xAFC0FFEE

Definition at line 65 of file AFMessages.h.

#define AF_ERROR   3

Definition at line 50 of file AFMessages.h.

#define AF_FAILURE ( __status__   )     (!AF_SUCCESS((__status__)))

Definition at line 63 of file AFMessages.h.

#define AF_INCLUDE_CODE   0

Definition at line 54 of file AFMessages.h.

#define AF_OUTPUT   4

Definition at line 51 of file AFMessages.h.

#define AF_STRINGIFY ( __err__   )     #__err__

Definition at line 64 of file AFMessages.h.

#define AF_SUCCESS ( __status__   )     (AFS_RETURN_BASE == ((__status__) & 0xffff0000))

Definition at line 62 of file AFMessages.h.

#define AF_TRACE   1

Definition at line 48 of file AFMessages.h.

#define AF_WARN   AF_DISABLE

Definition at line 52 of file AFMessages.h.

#define INCLUDE_CODE ( statement   ) 

Definition at line 59 of file AFMessages.h.


Enumeration Type Documentation

enum AF_STATUS
Enumerator:
AFS_RETURN_BASE 
AFS_SUCCESS 
AFS_ERROR_BASE 
AFS_FAILURE 
AFS_DATA_TIMED_OUT 
AFS_NOT_IMPLEMENTED 
AFS_INVALID_PARAMETER 
AFS_OUTOFMEMORY 
AFS_IOCONTROL_FAILED 

Definition at line 67 of file AFMessages.h.


Function Documentation

void AF_MSG ( int  type,
const char *  fmt,
  ... 
) [inline]

Print a message to standard output.

Parameters:
type The type of message (AF_TRACE, AF_DEBUG, AF_ERROR, AF_OUTPUT or AF_WARN).
fmt The format specifier.

Definition at line 94 of file AFMessages.h.

void DoSetLastError ( AF_STATUS  retval  )  [inline]

Given a AF_STATUS value set the corresponding system error using SetLastError.

Parameters:
retval The audio framework specific error value.

Definition at line 166 of file AFMessages.h.


Generated on Sun Sep 27 12:36:35 2009 for Audio Framework by  doxygen 1.6.1