OfxMessageSuiteV2::clearPersistentMessage

`OfxMessageSuiteV2::clearPersistentMessage`
Prev	Message Suite V2	Next

Name

OfxMessageSuiteV2::clearPersistentMessage — Clears any persistent message on an effect handle that was set by OfxMessageSuiteV2::setPersistentMessage . New for V2 message suite.

Synopsis

#include "ofxMessage.h"

OfxStatus (*clearPersistentMessage) ( void * handle ) ;

Arguments

handle - effect handle (descriptor or instance)

Description

\returns

kOfxStatOK - if the message was sucessfully cleared
kOfxStatErrBadHandle - the handle was rubbish
kOfxStatFailed - if the message could not be cleared for some reason

Clearing a message will clear any associated error state.

Prev	Up	Next
`OfxMessageSuiteV2::setPersistentMessage`	Home	OpenGL Render Suite