doc/_z_f_env_info_8h_source.html

#ifndef _ZFI_ZFEnvInfo_h_

#define _ZFI_ZFEnvInfo_h_


#include "ZFObject.h"

ZF_NAMESPACE_GLOBAL_BEGIN


typedef void (*ZFEnvSummaryCallback)(ZF_IN_OUT zfstring &ret);


ZF_NAMESPACE_BEGIN_REGISTER(ZFEnvInfo, ZF_NAMESPACE_GLOBAL)


// ============================================================

ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFCore, void, envSummary

        , ZFMP_IN_OUT(zfstring &, ret)

        )

ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, zfstring, envSummary)


extern ZFLIB_ZFCore void envSummaryCallbackRegister(

        ZF_IN const zfstring &name

        , ZF_IN ZFEnvSummaryCallback callback

        );

extern ZFLIB_ZFCore void envSummaryCallbackUnregister(ZF_IN const zfstring &name);


// ============================================================

ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFCore, void, systemName

        , ZFMP_IN_OUT(zfstring &, ret)

        )

ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, zfstring, systemName)

ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFCore, void, systemVersion

        , ZFMP_IN_OUT(zfstring &, ret)

        )

ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, zfstring, systemVersion)


// ============================================================

ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFCore, void, frameworkName

        , ZFMP_IN_OUT(zfstring &, ret)

        )

ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, zfstring, frameworkName)

ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFCore, void, frameworkVersion

        , ZFMP_IN_OUT(zfstring &, ret)

        )

ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, zfstring, frameworkVersion)


ZF_NAMESPACE_END(ZFEnvInfo)


ZF_NAMESPACE_GLOBAL_END

#endif // #ifndef _ZFI_ZFEnvInfo_h_


ZFLIB_ZFCore
#define ZFLIB_ZFCore
used to export symbols
Definition ZFCoreEnvDef.h:30

ZF_IN
#define ZF_IN
dummy macro that shows the param used as required input
Definition ZFCoreTypeDef_ClassType.h:180

ZF_IN_OUT
#define ZF_IN_OUT
dummy macro that shows the param used as required input and output
Definition ZFCoreTypeDef_ClassType.h:196

zfstring
zft_zfstring< zfchar > zfstring
see zft_zfstring
Definition ZFCoreTypeDef_StringType.h:15

ZFEnvSummaryCallback
void(* ZFEnvSummaryCallback)(zfstring &ret)
see ZFEnvInfo::envSummaryCallbackRegister
Definition ZFEnvInfo.h:13

ZFMP_IN_OUT
#define ZFMP_IN_OUT(ParamType, paramName)
see ZFMP_IN
Definition ZFMethod.h:117

ZFMETHOD_FUNC_DECLARE_0
#define ZFMETHOD_FUNC_DECLARE_0(ZFLIB_, ReturnType, MethodName)
declare function type of ZFMethod
Definition ZFMethodFuncDeclare.h:493

ZFMETHOD_FUNC_DECLARE_1
#define ZFMETHOD_FUNC_DECLARE_1(ZFLIB_, ReturnType, MethodName, ZFMP_0)
see ZFMETHOD_FUNC_DECLARE_0
Definition ZFMethodFuncDeclare.h:624

ZF_NAMESPACE_BEGIN_REGISTER
#define ZF_NAMESPACE_BEGIN_REGISTER(NameSpace, ParentNameSpace)
begin and register namespace
Definition ZFNamespace.h:48

ZF_NAMESPACE_GLOBAL_BEGIN
#define ZF_NAMESPACE_GLOBAL_BEGIN
begin namespace ZFFramework
Definition ZFNamespace.h:97

ZF_NAMESPACE_END
#define ZF_NAMESPACE_END(NameSpace)
end namespace
Definition ZFNamespace.h:60

ZF_NAMESPACE_GLOBAL_END
#define ZF_NAMESPACE_GLOBAL_END
end namespace ZFFramework
Definition ZFNamespace.h:98

ZF_NAMESPACE_GLOBAL
#define ZF_NAMESPACE_GLOBAL
namespace of ZFFramework
Definition ZFNamespace.h:96

ZFObject.h
ZFObject related include.

ZFEnvInfo
Definition ZFEnvInfo.h:15

ZFEnvInfo::systemName
void systemName(zfstring &ret)
name of native system, e.g. "iOS", empty if not available

ZFEnvInfo::systemVersion
void systemVersion(zfstring &ret)
version of native system, e.g. "9.0.1", empty if not available

ZFEnvInfo::envSummaryCallbackRegister
void envSummaryCallbackRegister(const zfstring &name, ZFEnvSummaryCallback callback)
register a callback to output custom env info, see envSummary

ZFEnvInfo::frameworkName
void frameworkName(zfstring &ret)
name of native framework, e.g. "Qt", empty if not available

ZFEnvInfo::envSummaryCallbackUnregister
void envSummaryCallbackUnregister(const zfstring &name)
see envSummaryCallbackRegister

ZFEnvInfo::frameworkVersion
void frameworkVersion(zfstring &ret)
version of native framework, e.g. "9.0.1", empty if not available

ZFEnvInfo::envSummary
void envSummary(zfstring &ret)
util method to get summary info