UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Macros
VarArgs.h File Reference
#include "CoreTypes.h"

Go to the source code of this file.

Macros

#define GET_TYPED_VARARGS(CharType, msg, msgsize, len, lastarg, fmt)
 
#define GET_VARARGS( msg, msgsize, len, lastarg, fmt)   UE_DEPRECATED_MACRO(5.4, "GET_VARARGS(...) has been deprecated - please use GET_TYPED_VARARGS(TCHAR, ...) instead") GET_TYPED_VARARGS(TCHAR, msg, msgsize, len, lastarg, fmt)
 
#define GET_VARARGS_WIDE(msg, msgsize, len, lastarg, fmt)   UE_DEPRECATED_MACRO(5.4, "GET_VARARGS_WIDE(...) has been deprecated - please use GET_TYPED_VARARGS(WIDECHAR, ...) instead") GET_TYPED_VARARGS(WIDECHAR, msg, msgsize, len, lastarg, fmt)
 
#define GET_VARARGS_ANSI(msg, msgsize, len, lastarg, fmt)   UE_DEPRECATED_MACRO(5.4, "GET_VARARGS_ANSI(...) has been deprecated - please use GET_TYPED_VARARGS(ANSICHAR, ...) instead") GET_TYPED_VARARGS(ANSICHAR, msg, msgsize, len, lastarg, fmt)
 
#define GET_TYPED_VARARGS_RESULT(CharType, msg, msgsize, len, lastarg, fmt, result)
 
#define GET_VARARGS_RESULT( msg, msgsize, len, lastarg, fmt, result)   UE_DEPRECATED_MACRO(5.4, "GET_VARARGS(...) has been deprecated - please use GET_TYPED_VARARGS(TCHAR, ...) instead") GET_TYPED_VARARGS_RESULT(TCHAR, msg, msgsize, len, lastarg, fmt, result)
 
#define GET_VARARGS_RESULT_WIDE(msg, msgsize, len, lastarg, fmt, result)   UE_DEPRECATED_MACRO(5.4, "GET_VARARGS_RESULT_WIDE(...) has been deprecated - please use GET_TYPED_VARARGS(WIDECHAR, ...) instead") GET_TYPED_VARARGS_RESULT(WIDECHAR, msg, msgsize, len, lastarg, fmt, result)
 
#define GET_VARARGS_RESULT_ANSI(msg, msgsize, len, lastarg, fmt, result)   UE_DEPRECATED_MACRO(5.4, "GET_VARARGS_RESULT_ANSI(...) has been deprecated - please use GET_TYPED_VARARGS(ANSICHAR, ...) instead") GET_TYPED_VARARGS_RESULT(ANSICHAR, msg, msgsize, len, lastarg, fmt, result)
 
#define GET_VARARGS_RESULT_UTF8(msg, msgsize, len, lastarg, fmt, result)   UE_DEPRECATED_MACRO(5.4, "GET_VARARGS_RESULT_UTF8(...) has been deprecated - please use GET_TYPED_VARARGS(UTF8CHAR, ...) instead") GET_TYPED_VARARGS_RESULT(UTF8CHAR, msg, msgsize, len, lastarg, fmt, result)
 
#define VARARG_EXTRA(...)   __VA_ARGS__,
 
#define VARARG_NONE
 
#define VARARG_PURE   =0
 

Macro Definition Documentation

◆ GET_TYPED_VARARGS

#define GET_TYPED_VARARGS (   CharType,
  msg,
  msgsize,
  len,
  lastarg,
  fmt 
)
Value:
{ \
va_list ap; \
va_start(ap, lastarg); \
TCString<CharType>::GetVarArgs(msg, msgsize, fmt, ap); \
va_end(ap); \
}
fmt
OODEFFUNC typedef const char int const char * fmt
Definition oodle2.h:678
StaticCastSharedRef
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127

◆ GET_TYPED_VARARGS_RESULT

#define GET_TYPED_VARARGS_RESULT (   CharType,
  msg,
  msgsize,
  len,
  lastarg,
  fmt,
  result 
)
Value:
{ \
va_list ap; \
va_start(ap, lastarg); \
result = TCString<CharType>::GetVarArgs(msg, msgsize, fmt, ap); \
if (result >= msgsize) \
{ \
result = -1; \
} \
va_end(ap); \
}
TCString::GetVarArgs
static UE_FORCEINLINE_HINT int32 GetVarArgs(CharType *Dest, SIZE_T DestSize, const CharType *&Fmt, va_list ArgPtr)
Definition CString.h:1222

◆ GET_VARARGS

#define GET_VARARGS (   msg,
  msgsize,
  len,
  lastarg,
  fmt 
)    UE_DEPRECATED_MACRO(5.4, "GET_VARARGS(...) has been deprecated - please use GET_TYPED_VARARGS(TCHAR, ...) instead") GET_TYPED_VARARGS(TCHAR, msg, msgsize, len, lastarg, fmt)

◆ GET_VARARGS_ANSI

#define GET_VARARGS_ANSI (   msg,
  msgsize,
  len,
  lastarg,
  fmt 
)    UE_DEPRECATED_MACRO(5.4, "GET_VARARGS_ANSI(...) has been deprecated - please use GET_TYPED_VARARGS(ANSICHAR, ...) instead") GET_TYPED_VARARGS(ANSICHAR, msg, msgsize, len, lastarg, fmt)

◆ GET_VARARGS_RESULT

#define GET_VARARGS_RESULT (   msg,
  msgsize,
  len,
  lastarg,
  fmt,
  result 
)    UE_DEPRECATED_MACRO(5.4, "GET_VARARGS(...) has been deprecated - please use GET_TYPED_VARARGS(TCHAR, ...) instead") GET_TYPED_VARARGS_RESULT(TCHAR, msg, msgsize, len, lastarg, fmt, result)

◆ GET_VARARGS_RESULT_ANSI

#define GET_VARARGS_RESULT_ANSI (   msg,
  msgsize,
  len,
  lastarg,
  fmt,
  result 
)    UE_DEPRECATED_MACRO(5.4, "GET_VARARGS_RESULT_ANSI(...) has been deprecated - please use GET_TYPED_VARARGS(ANSICHAR, ...) instead") GET_TYPED_VARARGS_RESULT(ANSICHAR, msg, msgsize, len, lastarg, fmt, result)

◆ GET_VARARGS_RESULT_UTF8

#define GET_VARARGS_RESULT_UTF8 (   msg,
  msgsize,
  len,
  lastarg,
  fmt,
  result 
)    UE_DEPRECATED_MACRO(5.4, "GET_VARARGS_RESULT_UTF8(...) has been deprecated - please use GET_TYPED_VARARGS(UTF8CHAR, ...) instead") GET_TYPED_VARARGS_RESULT(UTF8CHAR, msg, msgsize, len, lastarg, fmt, result)

◆ GET_VARARGS_RESULT_WIDE

#define GET_VARARGS_RESULT_WIDE (   msg,
  msgsize,
  len,
  lastarg,
  fmt,
  result 
)    UE_DEPRECATED_MACRO(5.4, "GET_VARARGS_RESULT_WIDE(...) has been deprecated - please use GET_TYPED_VARARGS(WIDECHAR, ...) instead") GET_TYPED_VARARGS_RESULT(WIDECHAR, msg, msgsize, len, lastarg, fmt, result)

◆ GET_VARARGS_WIDE

#define GET_VARARGS_WIDE (   msg,
  msgsize,
  len,
  lastarg,
  fmt 
)    UE_DEPRECATED_MACRO(5.4, "GET_VARARGS_WIDE(...) has been deprecated - please use GET_TYPED_VARARGS(WIDECHAR, ...) instead") GET_TYPED_VARARGS(WIDECHAR, msg, msgsize, len, lastarg, fmt)

◆ VARARG_EXTRA

#define VARARG_EXTRA (   ...)    __VA_ARGS__,

◆ VARARG_NONE

#define VARARG_NONE

◆ VARARG_PURE

#define VARARG_PURE   =0