6-docs/doxygen/env_defs_8h_source.html

 /*************************************************************************\

 * Copyright (c) 2002 The University of Chicago, as Operator of Argonne

 * National Laboratory.

 * Copyright (c) 2002 The Regents of the University of California, as

 * Operator of Los Alamos National Laboratory.

 * SPDX-License-Identifier: EPICS

 * EPICS BASE is distributed subject to a Software License Agreement found

 * in file LICENSE that is included with this distribution.

 \*************************************************************************/


 #ifndef envDefsH

 #define envDefsH


 #ifdef __cplusplus

 extern "C" {

 #endif


 #include "libComAPI.h"


 typedef struct envParam {

  char *name;

  char *pdflt;

 } ENV_PARAM;


 LIBCOM_API extern const ENV_PARAM EPICS_CA_ADDR_LIST;

 LIBCOM_API extern const ENV_PARAM EPICS_CA_CONN_TMO;

 LIBCOM_API extern const ENV_PARAM EPICS_CA_AUTO_ADDR_LIST;

 LIBCOM_API extern const ENV_PARAM EPICS_CA_REPEATER_PORT;

 LIBCOM_API extern const ENV_PARAM EPICS_CA_SERVER_PORT;

 LIBCOM_API extern const ENV_PARAM EPICS_CA_MAX_ARRAY_BYTES;

 LIBCOM_API extern const ENV_PARAM EPICS_CA_AUTO_ARRAY_BYTES;

 LIBCOM_API extern const ENV_PARAM EPICS_CA_MAX_SEARCH_PERIOD;

 LIBCOM_API extern const ENV_PARAM EPICS_CA_NAME_SERVERS;

 LIBCOM_API extern const ENV_PARAM EPICS_CA_MCAST_TTL;

 LIBCOM_API extern const ENV_PARAM EPICS_CAS_INTF_ADDR_LIST;

 LIBCOM_API extern const ENV_PARAM EPICS_CAS_IGNORE_ADDR_LIST;

 LIBCOM_API extern const ENV_PARAM EPICS_CAS_AUTO_BEACON_ADDR_LIST;

 LIBCOM_API extern const ENV_PARAM EPICS_CAS_BEACON_ADDR_LIST;

 LIBCOM_API extern const ENV_PARAM EPICS_CAS_SERVER_PORT;

 LIBCOM_API extern const ENV_PARAM EPICS_CA_BEACON_PERIOD;

 LIBCOM_API extern const ENV_PARAM EPICS_CAS_BEACON_PERIOD;

 LIBCOM_API extern const ENV_PARAM EPICS_CAS_BEACON_PORT;

 LIBCOM_API extern const ENV_PARAM EPICS_BUILD_COMPILER_CLASS;

 LIBCOM_API extern const ENV_PARAM EPICS_BUILD_OS_CLASS;

 LIBCOM_API extern const ENV_PARAM EPICS_BUILD_TARGET_ARCH;

 LIBCOM_API extern const ENV_PARAM EPICS_TZ;

 LIBCOM_API extern const ENV_PARAM EPICS_TS_NTP_INET;

 LIBCOM_API extern const ENV_PARAM EPICS_IOC_IGNORE_SERVERS;

 LIBCOM_API extern const ENV_PARAM EPICS_IOC_LOG_PORT;

 LIBCOM_API extern const ENV_PARAM EPICS_IOC_LOG_INET;

 LIBCOM_API extern const ENV_PARAM EPICS_IOC_LOG_FILE_LIMIT;

 LIBCOM_API extern const ENV_PARAM EPICS_IOC_LOG_FILE_NAME;

 LIBCOM_API extern const ENV_PARAM EPICS_IOC_LOG_FILE_COMMAND;

 LIBCOM_API extern const ENV_PARAM IOCSH_PS1;

 LIBCOM_API extern const ENV_PARAM IOCSH_HISTSIZE;

 LIBCOM_API extern const ENV_PARAM IOCSH_HISTEDIT_DISABLE;

 LIBCOM_API extern const ENV_PARAM *env_param_list[];


 struct in_addr;


 LIBCOM_API char * epicsStdCall

  envGetConfigParam(const ENV_PARAM *pParam, int bufDim, char *pBuf);


 LIBCOM_API const char * epicsStdCall

  envGetConfigParamPtr(const ENV_PARAM *pParam);


 LIBCOM_API long epicsStdCall

  envPrtConfigParam(const ENV_PARAM *pParam);


 LIBCOM_API long epicsStdCall

  envGetInetAddrConfigParam(const ENV_PARAM *pParam, struct in_addr *pAddr);


 LIBCOM_API long epicsStdCall

  envGetDoubleConfigParam(const ENV_PARAM *pParam, double *pDouble);


 LIBCOM_API long epicsStdCall

  envGetLongConfigParam(const ENV_PARAM *pParam, long *pLong);


 LIBCOM_API unsigned short epicsStdCall envGetInetPortConfigParam

  (const ENV_PARAM *pEnv, unsigned short defaultPort);

 LIBCOM_API long epicsStdCall

  envGetBoolConfigParam(const ENV_PARAM *pParam, int *pBool);


 LIBCOM_API long epicsStdCall epicsPrtEnvParams(void);


 LIBCOM_API void epicsStdCall epicsEnvSet (const char *name, const char *value);

 LIBCOM_API void epicsStdCall epicsEnvUnset (const char *name);

 LIBCOM_API void epicsStdCall epicsEnvShow (const char *name);


 #ifdef __cplusplus

 }

 #endif


 #endif /*envDefsH*/

value
Definition: link.h:175

EPICS_CA_BEACON_PERIOD
LIBCOM_API const ENV_PARAM EPICS_CA_BEACON_PERIOD
deprecated

epicsEnvUnset
LIBCOM_API void epicsStdCall epicsEnvUnset(const char *name)
Clear the value of an environment variable.

ENV_PARAM::pdflt
char * pdflt
Default value.
Definition: envDefs.h:44

envPrtConfigParam
LIBCOM_API long epicsStdCall envPrtConfigParam(const ENV_PARAM *pParam)
Print the value of a configuration parameter.

envGetLongConfigParam
LIBCOM_API long epicsStdCall envGetLongConfigParam(const ENV_PARAM *pParam, long *pLong)
Get value of a long configuration parameter.

epicsEnvShow
LIBCOM_API void epicsStdCall epicsEnvShow(const char *name)
Print value of an environment variable, or all variables.

envGetConfigParamPtr
LIBCOM_API const char *epicsStdCall envGetConfigParamPtr(const ENV_PARAM *pParam)
Get a configuration parameter&#39;s value or default string.

envGetConfigParam
LIBCOM_API char *epicsStdCall envGetConfigParam(const ENV_PARAM *pParam, int bufDim, char *pBuf)
Get value of a configuration parameter.

envGetInetAddrConfigParam
LIBCOM_API long epicsStdCall envGetInetAddrConfigParam(const ENV_PARAM *pParam, struct in_addr *pAddr)
Get value of an inet addr config parameter.

epicsPrtEnvParams
LIBCOM_API long epicsStdCall epicsPrtEnvParams(void)
Prints all configuration parameters and their current value.

ENV_PARAM
A structure to hold a single environment parameter.
Definition: envDefs.h:42

envGetDoubleConfigParam
LIBCOM_API long epicsStdCall envGetDoubleConfigParam(const ENV_PARAM *pParam, double *pDouble)
Get value of a double configuration parameter.

ENV_PARAM::name
char * name
Name of the parameter.
Definition: envDefs.h:43

envGetInetPortConfigParam
LIBCOM_API unsigned short epicsStdCall envGetInetPortConfigParam(const ENV_PARAM *pEnv, unsigned short defaultPort)
Get value of a port number configuration parameter.

envGetBoolConfigParam
LIBCOM_API long epicsStdCall envGetBoolConfigParam(const ENV_PARAM *pParam, int *pBool)
Get value of a boolean configuration parameter.

epicsEnvSet
LIBCOM_API void epicsStdCall epicsEnvSet(const char *name, const char *value)
Set an environment variable&#39;s value.