Files
pcas/src/libCom/env/envDefs.h
W. Eric Norum 84cd107ad9 Make epicsEnvShow work when called from vxWorks shell or iocsh.
Limits operation to a single argument.
2001-05-17 16:56:14 +00:00

133 lines
4.6 KiB
C

/* $Id$
* Author: Roger A. Cole
* Date: 07-20-91
*
* Experimental Physics and Industrial Control System (EPICS)
*
* Copyright 1991, the Regents of the University of California,
* and the University of Chicago Board of Governors.
*
* This software was produced under U.S. Government contracts:
* (W-7405-ENG-36) at the Los Alamos National Laboratory,
* and (W-31-109-ENG-38) at Argonne National Laboratory.
*
* Initial development by:
* The Controls and Automation Group (AT-8)
* Ground Test Accelerator
* Accelerator Technology Division
* Los Alamos National Laboratory
*
* Co-developed with
* The Controls and Computing Group
* Accelerator Systems Division
* Advanced Photon Source
* Argonne National Laboratory
*
* Modification Log:
* -----------------
* .01 07-20-91 rac initial version
* .02 08-07-91 joh added ioc log env
* .03 09-26-94 joh ifdef out double inclusion
* .04 11-28-94 joh new CA env var
* .05 04-20-95 anj moved defaults to CONFIG_ENV
* .06 09-11-96 joh ANSI prototypes
* .07 09-18-96 joh added envParamIsEmpty()
* .08 03-18-97 joh remove env param length limit
*
* make options
* -DNDEBUG don't compile assert() checking
* -DDEBUG compile various debug code, including checks on
* malloc'd memory
*/
/*+/mod***********************************************************************
* TITLE envDefs.h - definitions for environment get/set routines
*
* DESCRIPTION
* This file defines the environment parameters for EPICS. These
* ENV_PARAM's are initialized by $epics/share/bin/envSetupParams for
* use by EPICS programs running under UNIX and VxWorks.
*
* User programs can define their own environment parameters for their
* own use--the only caveat is that such parameters aren't automatically
* setup by EPICS.
*
* SEE ALSO
* $epics/share/bin/envSetupParams, envSubr.c
*
*-***************************************************************************/
#ifndef envDefsH
#define envDefsH
#ifdef __cplusplus
extern "C" {
#endif
#include "shareLib.h"
#include "osiSock.h"
typedef struct envParam {
char *name; /* text name of the parameter */
char *pdflt;
} ENV_PARAM;
/*
* bldEnvData looks for "epicsShareExtern READONLY ENV_PARAM"
*/
epicsShareExtern READONLY ENV_PARAM EPICS_CA_ADDR_LIST;
epicsShareExtern READONLY ENV_PARAM EPICS_CA_CONN_TMO;
epicsShareExtern READONLY ENV_PARAM EPICS_CA_BEACON_PERIOD;
epicsShareExtern READONLY ENV_PARAM EPICS_CA_AUTO_ADDR_LIST;
epicsShareExtern READONLY ENV_PARAM EPICS_CA_REPEATER_PORT;
epicsShareExtern READONLY ENV_PARAM EPICS_CA_SERVER_PORT;
epicsShareExtern READONLY ENV_PARAM EPICS_CAS_INTF_ADDR_LIST;
epicsShareExtern READONLY ENV_PARAM EPICS_CAS_BEACON_ADDR_LIST;
epicsShareExtern READONLY ENV_PARAM EPICS_CAS_SERVER_PORT;
epicsShareExtern READONLY ENV_PARAM EPICS_TS_MIN_WEST;
epicsShareExtern READONLY ENV_PARAM EPICS_TS_NTP_INET;
epicsShareExtern READONLY ENV_PARAM EPICS_IOC_LOG_PORT;
epicsShareExtern READONLY ENV_PARAM EPICS_IOC_LOG_INET;
epicsShareExtern READONLY ENV_PARAM EPICS_IOC_LOG_FILE_LIMIT;
epicsShareExtern READONLY ENV_PARAM EPICS_IOC_LOG_FILE_NAME;
epicsShareExtern READONLY ENV_PARAM EPICS_IOC_LOG_FILE_COMMAND;
epicsShareExtern READONLY ENV_PARAM EPICS_CMD_PROTO_PORT;
epicsShareExtern READONLY ENV_PARAM EPICS_AR_PORT;
#define EPICS_ENV_VARIABLE_COUNT 18
/*
* N elements added here to satisfy microsoft development tools
* (includes room for nill termination)
*
* bldEnvData looks for "epicsShareExtern ENV_PARAM" so
* this always needs to be divided into two lines
*/
epicsShareExtern READONLY ENV_PARAM
*env_param_list[EPICS_ENV_VARIABLE_COUNT+1];
epicsShareFunc char * epicsShareAPI
envGetConfigParam(const ENV_PARAM *pParam, int bufDim, char *pBuf);
epicsShareFunc const char * epicsShareAPI
envGetConfigParamPtr(const ENV_PARAM *pParam);
epicsShareFunc long epicsShareAPI
envPrtConfigParam(const ENV_PARAM *pParam);
epicsShareFunc long epicsShareAPI
envGetInetAddrConfigParam(const ENV_PARAM *pParam, struct in_addr *pAddr);
epicsShareFunc long epicsShareAPI
envGetDoubleConfigParam(const ENV_PARAM *pParam, double *pDouble);
epicsShareFunc long epicsShareAPI
envGetLongConfigParam(const ENV_PARAM *pParam, long *pLong);
epicsShareFunc const char * epicsShareAPI
envGetConfigParamPtr(const ENV_PARAM *pParam);
epicsShareFunc unsigned short epicsShareAPI envGetInetPortConfigParam
(const ENV_PARAM *pEnv, unsigned short defaultPort);
epicsShareFunc long epicsShareAPI epicsPrtEnvParams(void);
epicsShareFunc void epicsShareAPI epicsEnvSet (char *name, char *value);
epicsShareFunc void epicsShareAPI epicsEnvShow (const char *name);
#ifdef __cplusplus
}
#endif
#endif /*envDefsH*/