getIntEnv

C++ Function Reference

1 Signature

static int getIntEnv(const char *name, int def)

2 Description

Retrieves integer value from environment variable.

3 Parameters

name (const char *): Environment variable name
def (int): Default value if not found or invalid

4 Returns

int Parsed value or default

5 Details

nameEnvironment variable name defDefault value if not found or invalid int Parsed value or defaultHandles empty or missing environment variablesValidates numeric formatEnsures positive integer valuesIssues warning for invalid values

6 Call Graph

7 Source Code

Implementation

File: inst/include/Utilities/openme-utils.hpp • Lines 66-82

static int getIntEnv(const char *name, int def)
{
    const char *val = getenv(name);
    if (val==NULL) return def;
    size_t nchar = strlen(val);
    if (nchar==0) return def;
    char *end;
    errno = 0;
    long int ans = strtol(val, &end, 10);  // ignores leading whitespace. If it fully consumed the string, *end=='\0' and isspace('\0')==false
    while (isspace(*end)) end++;  // ignore trailing whitespace
    if (errno || (size_t)(end-val)!=nchar || ans<1 || ans>INT_MAX) {
        Rcpp::warning(("Ignoring invalid %s==\"%s\". Not an integer >= 1. Please remove any characters that are not a digit [0-9]."), name, val);
        return def;
        
    }
    return (int)ans;
}

8 Usage Example

#include "BigDataStatMeth.hpp"

// Example usage
auto result = getIntEnv(...);

---
title: "getIntEnv"
subtitle: "C++ Function Reference"
---

## Signature

```cpp
static int getIntEnv(const char *name, int def)
```

## Description

Retrieves integer value from environment variable.

## Parameters

- `name` (`const char *`): Environment variable name
- `def` (`int`): Default value if not found or invalid

## Returns

int Parsed value or default

## Details

nameEnvironment variable name defDefault value if not found or invalid int Parsed value or defaultHandles empty or missing environment variablesValidates numeric formatEnsures positive integer valuesIssues warning for invalid values

## Call Graph

::: {.diagram-section}
<object type="image/svg+xml" data="images/_big_data_stat_meth_8hpp_a32e65a19d36ceec1952e48362e4153b8_cgraph.svg" class="class-diagram">
  <img src="images/_big_data_stat_meth_8hpp_a32e65a19d36ceec1952e48362e4153b8_cgraph.svg" alt="Function dependencies"/>
</object>
:::

## Source Code

::: {.callout-note collapse="true"}
### Implementation

**File:** `inst/include/Utilities/openme-utils.hpp` • **Lines 66-82**

```cpp
static int getIntEnv(const char *name, int def)
{
    const char *val = getenv(name);
    if (val==NULL) return def;
    size_t nchar = strlen(val);
    if (nchar==0) return def;
    char *end;
    errno = 0;
    long int ans = strtol(val, &end, 10);  // ignores leading whitespace. If it fully consumed the string, *end=='\0' and isspace('\0')==false
    while (isspace(*end)) end++;  // ignore trailing whitespace
    if (errno || (size_t)(end-val)!=nchar || ans<1 || ans>INT_MAX) {
        Rcpp::warning(("Ignoring invalid %s==\"%s\". Not an integer >= 1. Please remove any characters that are not a digit [0-9]."), name, val);
        return def;
        
    }
    return (int)ans;
}
```
:::

## Usage Example

```cpp
#include "BigDataStatMeth.hpp"

// Example usage
auto result = getIntEnv(...);
```