| AAX SDK 2.8.0 Avid Audio Extensions Development Kit

- Welcome
- Manual
- Classes
- Files
- Lists
- Support

- Class List
- Class Index
- Class Hierarchy
- Class Members

Loading...
Searching...
No Matches
List of all members | Public Member Functions
AAX_IACFHostServices Class Referenceabstract

`#include <AAX_IACFHostServices.h>`

Inheritance diagram for AAX_IACFHostServices:
[legend]
Collaboration diagram for AAX_IACFHostServices:
[legend]

## Description

Versioned interface to diagnostic and debugging services provided by the AAX host.

## Public Member Functions
virtual AAX_Result | Assert (const char *iFile, int32_t iLine, const char *iNote)=0
virtual AAX_Result | Trace (int32_t iPriority, const char *iMessage)=0
| Log a trace message.
Public Member Functions inherited from IACFUnknown
virtual BEGIN_ACFINTERFACE ACFRESULT ACFMETHODCALLTYPE | QueryInterface (const acfIID &iid, void **ppOut)=0
| Returns pointers to supported interfaces.
virtual acfUInt32 ACFMETHODCALLTYPE | AddRef (void)=0
| Increments reference count.
virtual acfUInt32 ACFMETHODCALLTYPE | Release (void)=0
| Decrements reference count.

## Member Function Documentation

## ◆ Assert()

virtual AAX_Result AAX_IACFHostServices::Assert | ( | const char * | iFile,
|  | int32_t | iLine,
|  | const char * | iNote
| ) |  |
| pure virtual

Deprecated:
  Legacy version of AAX_IACFHostServices_V3::HandleAssertFailure() implemented by older hosts

Prior to AAX_IACFHostServices_V3::HandleAssertFailure(), the AAX_ASSERT macro, a wrapper around Assert(), was only compiled into debug plug-in builds. AAX_ASSERT is now compiled in to all plug-in builds and the original debug-only form is available through AAX_DEBUGASSERT.

Because the implementation of Assert() in the host is not aware of the plug-in's build configuation, older hosts implemented this method with a warning dialog in all cases. Newer hosts - those which implement HandleAssertFailure() - will log assertion failures but will not present any user dialog in shipping builds of the host software.

In order to prevent assertion failure dialogs from appearing to users who run new builds of plug-ins containing AAX_ASSERT calls in older hosts the deprecated Assert() method should only be called from debug plug-in builds.

## ◆ Trace()

virtual AAX_Result AAX_IACFHostServices::Trace | ( | int32_t | iPriority,
|  | const char * | iMessage
| ) |  |
| pure virtual

Log a trace message.

Parameters

  [in] | iPriority | Priority of the trace, used for log filtering. One of kAAX_Trace_Priority_Low, kAAX_Trace_Priority_Normal, kAAX_Trace_Priority_High
  [in] | iMessage | Message string to log

The documentation for this class was generated from the following file:

- AAX_IACFHostServices.h