ofdeprec.h File Reference

Defines macros for marking functions as deprecated. More...

Macros
#define	OFdeprecated   <unspecified>
	A macro for marking a function as deprecated. More...
#define	OFdeprecated_msg(MESSAGE)   <unspecified>
	A macro for marking a function as deprecated with a custom message. More...

Detailed Description

Defines macros for marking functions as deprecated.

#include "dcmtk/ofstd/ofdeprec.h"

Macro Definition Documentation

OFdeprecated

#define OFdeprecated   <unspecified>

A macro for marking a function as deprecated.

Example

OFdeprecated void myFunction() {...}

If the compiler supports function deprecation, using this macro will lead to a diagnostic message being emitted whenever the marked function is used.

OFdeprecated_msg

#define OFdeprecated_msg

(

MESSAGE

)

<unspecified>

A macro for marking a function as deprecated with a custom message.

Parameters

MESSAGE

the message to print as part of the diagnostic output.

Example

OFdeprecated_msg("use myNewFunction() instead") void myFunction() {...}
void myNewFunction() {...}

If the compiler supports function deprecation with a custom message, using this macro will lead to a diagnostic message including the custom message being emitted whenever the marked function is used. If the compiler does not support custom messages, it will fall back to OFdeprecated.