User's Guide
Reference Manual
Release Notes
PDF
Top

inets
Reference Manual
Version 5.9.5

Expand All
Contract All

Table of Contents

# httpd_conf

### MODULE

httpd_conf

### MODULE SUMMARY

Configuration utility functions to be used by the Erlang Web server API programmer.

### DESCRIPTION

This module provides the Erlang Webserver API programmer with utility functions for adding run-time configuration directives.

### EXPORTS

check_enum(EnumString, ValidEnumStrings) -> Result

Types:

EnumString = string()
ValidEnumStrings = [string()]
Result = {ok,atom()} | {error,not_valid}

check_enum/2 checks if EnumString is a valid enumeration of ValidEnumStrings in which case it is returned as an atom.

clean(String) -> Stripped

Types:

String = Stripped = string()

clean/1 removes leading and/or trailing white spaces from String.

custom_clean(String,Before,After) -> Stripped

Types:

Before = After = regexp()
String = Stripped = string()

custom_clean/3 removes leading and/or trailing white spaces and custom characters from String. Before and After are regular expressions, as defined in regexp(3), describing the custom characters.

is_directory(FilePath) -> Result

Types:

FilePath = string()
Result = {ok,Directory} | {error,Reason}
Directory = string()
Reason = string() | enoent | eaccess | enotdir | FileInfo
FileInfo = File info record

is_directory/1 checks if FilePath is a directory in which case it is returned. Please read file(3) for a description of enoent, eaccess and enotdir. The definition of the file info record can be found by including file.hrl from the kernel application, see file(3).

is_file(FilePath) -> Result

Types:

FilePath = string()
Result = {ok,File} | {error,Reason}
File = string()
Reason = string() | enoent | eaccess | enotdir | FileInfo
FileInfo = File info record

is_file/1 checks if FilePath is a regular file in which case it is returned. Read file(3) for a description of enoent, eaccess and enotdir. The definition of the file info record can be found by including file.hrl from the kernel application, see file(3).

make_integer(String) -> Result

Types:

String = string()
Result = {ok,integer()} | {error,nomatch}

make_integer/1 returns an integer representation of String.

### SEE ALSO

httpd(3)