eyBuildLib API Reference : eyBuildLib

ebenviron

NAME

ebenviron - CGI environment variable

ROUTINES

ebResetGetenv( ) - reset getenv( ) for eybuild library
ebgetenv( ) - get the value of envirement variable
getHttpHeader( ) - get the value of specified HTTP header name
getAuthType( ) - get auth type (AUTH_TYPE)
getContentLength( ) - get content length (CONTENT_LENGTH)
getContentType( ) - get content type (CONTENT_TYPE)
getGatewayInterface( ) - get gateway interface (GATEWAY_INTERFACE)
getPathInfo( ) - get path info (PATH_INFO)
getPathTranslated( ) - get path translated name (PATH_TRANSLATED)
getQueryString( ) - get questry string (QUERY_STRING)
getRemoteAddr( ) - get remote host IP Address or URL (REMOTE_ADDR)
getRemoteHost( ) - get remote host IP Address or URL (REMOTE_HOST)
getRemoteIdent( ) - get remote ident (REMOTE_IDENT)
getRemotePort( ) - get remote host port (REMOTE_PORT)
getRemoteUser( ) - get remote user (REMOTE_USER)
getRequestMethod( ) - get request method (REQUEST_METHOD)
getScriptName( ) - get script name (SCRIPT_NAME)
getServerAddr( ) - get server IP address (SERVER_ADDR)
getServerName( ) - get server name (SERVER_NAME)
getServerPort( ) - get server port (SERVER_PORT)
getServerProtocol( ) - get server protocol (SERVER_PROTOCOL)
getServerSoftware( ) - get server software (SERVER_SOFTWARE)
getHttpCookie( ) - get HTTP cookie list (HTTP_COOKIE)
getHttpConnection( ) - get connect state (HTTP_CONNECTION)
getHttpUserAgent( ) - get remote user agent (HTTP_USER_AGENT)
getHttpLastModified( ) - get the date last modified (HTTP_IF_MODIFIED_SINCE)
getHttpAccept( ) - get HTTP accept MIME type (HTTP_ACCEPT)
getHttpAcceptLanguage( ) - get browser accept language (HTTP_ACCEPT_LANGUAGE)
getHttpAcceptEncode( ) - get browser accept encode (HTTP_ACCEPT_ENCODING)
getHttpETag( ) - get HTTP entity tag (HTTP_IF_NONE_MATCH)

DESCRIPTION

CGI environment variable

INCLUDE

ebenviron.h


eyBuildLib : Routines

ebResetGetenv( )

NAME

ebResetGetenv( ) - reset getenv( ) for eybuild library

SYNOPSIS

FUNC_GETENV ebResetGetenv
    (
    FUNC_GETENV callback
    )

DESCRIPTION

This routine is to reset getenv( ) for eybuild library.

RETURNS

the old callback routine

SEE ALSO

ebenviron


eyBuildLib : Routines

ebgetenv( )

NAME

ebgetenv( ) - get the value of envirement variable

SYNOPSIS

char * ebgetenv
    (
    const char * varname
    )

DESCRIPTION

This routine is to get the value of envirement variable. It will return const blank string (""), if the environment variable not exist.

RETURNS

A pointer to the string value, or pointer to const string ""

SEE ALSO

ebenviron, stdlib.h getenv( )


eyBuildLib : Routines

getHttpHeader( )

NAME

getHttpHeader( ) - get the value of specified HTTP header name

SYNOPSIS

char * getHttpHeader
    (
    const char * name
    )

DESCRIPTION

This routine is to get the value of specified HTTP header name.

SEE ALSO

ebenviron, dopost dopost( ), getPostItemValue( ), getPostSrcFileName( )


eyBuildLib : Routines

getAuthType( )

NAME

getAuthType( ) - get auth type (AUTH_TYPE)

SYNOPSIS

char * getAuthType (void)

DESCRIPTION

This routine is to get auth type (AUTH_TYPE).

RETURN

pointer to auth type, or "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getContentLength( )

NAME

getContentLength( ) - get content length (CONTENT_LENGTH)

SYNOPSIS

size_t getContentLength (void)

DESCRIPTION

This routine is to get content length when method is POST (CONTENT_LENGTH).

RETURN

content length, or ERROR if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getContentType( )

NAME

getContentType( ) - get content type (CONTENT_TYPE)

SYNOPSIS

char * getContentType (void)

DESCRIPTION

This routine is to get content type if method is POST (CONTENT_TYPE).

RETURN

pointer to content type, or "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getGatewayInterface( )

NAME

getGatewayInterface( ) - get gateway interface (GATEWAY_INTERFACE)

SYNOPSIS

char * getGatewayInterface (void)

DESCRIPTION

This routine is to get gateway interface (GATEWAY_INTERFACE).

RETURN

pointer to gateway interface, otherwise "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getPathInfo( )

NAME

getPathInfo( ) - get path info (PATH_INFO)

SYNOPSIS

char * getPathInfo (void)

DESCRIPTION

This routine is to get the request path info (PATH_INFO), such as returns "/cgi-bin/test.cgi".

RETURN

pointer to path info, or "" if not found.

SEE ALSO

ebenviron


eyBuildLib : Routines

getPathTranslated( )

NAME

getPathTranslated( ) - get path translated name (PATH_TRANSLATED)

SYNOPSIS

char * getPathTranslated (void)

DESCRIPTION

This routine is to get the get path translated name.

RETURN

pointer to path translated name, or "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getQueryString( )

NAME

getQueryString( ) - get questry string (QUERY_STRING)

SYNOPSIS

char * getQueryString (void)

DESCRIPTION

This routine is to questry string (QUERY_STRING).

RETURN

pointer to questry string, or "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getRemoteAddr( )

NAME

getRemoteAddr( ) - get remote host IP Address or URL (REMOTE_ADDR)

SYNOPSIS

char * getRemoteAddr (void)

DESCRIPTION

This routine is to get remote host IP Address or URL (REMOTE_ADDR).

RETURN

pointer to remote address, or "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getRemoteHost( )

NAME

getRemoteHost( ) - get remote host IP Address or URL (REMOTE_HOST)

SYNOPSIS

char * getRemoteHost (void)

DESCRIPTION

This routine is to get remote host IP Address or URL (REMOTE_HOST).

RETURN

pointer to remote address, or "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getRemoteIdent( )

NAME

getRemoteIdent( ) - get remote ident (REMOTE_IDENT)

SYNOPSIS

char * getRemoteIdent (void)

DESCRIPTION

This routine is to get remote ident (REMOTE_IDENT), this value is not always security.

RETURN

pointer to remote address, or "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getRemotePort( )

NAME

getRemotePort( ) - get remote host port (REMOTE_PORT)

SYNOPSIS

short getRemotePort (void)

DESCRIPTION

This routine is to get remote host port (REMOTE_PORT).

RETURN

remote host, or ERROR if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getRemoteUser( )

NAME

getRemoteUser( ) - get remote user (REMOTE_USER)

SYNOPSIS

char * getRemoteUser (void)

DESCRIPTION

This routine is to get remote user (REMOTE_USER).

RETURN

pointer to remote user, or "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getRequestMethod( )

NAME

getRequestMethod( ) - get request method (REQUEST_METHOD)

SYNOPSIS

char * getRequestMethod (void)

DESCRIPTION

get request method (REQUEST_METHOD)

RETURN

pointer to method, or "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getScriptName( )

NAME

getScriptName( ) - get script name (SCRIPT_NAME)

SYNOPSIS

char * getScriptName (void)

DESCRIPTION

This routine is to get script name (SCRIPT_NAME).

RETURN

pointer to script name, or "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getServerAddr( )

NAME

getServerAddr( ) - get server IP address (SERVER_ADDR)

SYNOPSIS

char * getServerAddr (void)

DESCRIPTION

This routine is to get server name (SERVER_NAME).

RETURN

pointer to server IP address, otherwise "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getServerName( )

NAME

getServerName( ) - get server name (SERVER_NAME)

SYNOPSIS

char * getServerName (void)

DESCRIPTION

This routine is to get server name (SERVER_NAME).

RETURN

pointer to server name, otherwise "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getServerPort( )

NAME

getServerPort( ) - get server port (SERVER_PORT)

SYNOPSIS

short getServerPort (void)

DESCRIPTION

This routine is to get server port (SERVER_PORT).

RETURN

remote host, or ERROR if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getServerProtocol( )

NAME

getServerProtocol( ) - get server protocol (SERVER_PROTOCOL)

SYNOPSIS

char * getServerProtocol (void)

DESCRIPTION

This routine is to get server protocol (SERVER_PROTOCOL).

RETURN

pointer to server protocol, or "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getServerSoftware( )

NAME

getServerSoftware( ) - get server software (SERVER_SOFTWARE)

SYNOPSIS

char * getServerSoftware (void)

DESCRIPTION

This routine is to get server software (SERVER_SOFTWARE).

RETURN

pointer to server software, otherwise "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getHttpCookie( )

NAME

getHttpCookie( ) - get HTTP cookie list (HTTP_COOKIE)

SYNOPSIS

char * getHttpCookie (void)

DESCRIPTION

This routine is to get connect state (HTTP_CONNECTION), such as "Keep-Alive".

RETURN

pointer to cookie list , or "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getHttpConnection( )

NAME

getHttpConnection( ) - get connect state (HTTP_CONNECTION)

SYNOPSIS

char * getHttpConnection (void)

DESCRIPTION

This routine is to get connect state (HTTP_CONNECTION), such as "Keep-Alive".

RETURN

pointer to connection state , or "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getHttpUserAgent( )

NAME

getHttpUserAgent( ) - get remote user agent (HTTP_USER_AGENT)

SYNOPSIS

char * getHttpUserAgent (void)

DESCRIPTION

This routine is to get remote user agent (HTTP_USER_AGENT), such as Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1).

RETURN

pointer to user agent, or "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getHttpLastModified( )

NAME

getHttpLastModified( ) - get the date last modified (HTTP_IF_MODIFIED_SINCE)

SYNOPSIS

char * getHttpLastModified (void)

DESCRIPTION

This routine is to get the date last modified (HTTP_IF_MODIFIED_SINCE).

RETURN

pointer to the date last modified , otherwise "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getHttpAccept( )

NAME

getHttpAccept( ) - get HTTP accept MIME type (HTTP_ACCEPT)

SYNOPSIS

char * getHttpAccept (void)

DESCRIPTION

This routine is to get HTTP accept MIME type (HTTP_ACCEPT).

RETURN

pointer to the accept MIME type, or "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getHttpAcceptLanguage( )

NAME

getHttpAcceptLanguage( ) - get browser accept language (HTTP_ACCEPT_LANGUAGE)

SYNOPSIS

char * getHttpAcceptLanguage (void)

DESCRIPTION

This routine is to get browser accept language (HTTP_ACCEPT_LANGUAGE).

RETURN

pointer to the accept language, otherwise "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getHttpAcceptEncode( )

NAME

getHttpAcceptEncode( ) - get browser accept encode (HTTP_ACCEPT_ENCODING)

SYNOPSIS

char * getHttpAcceptEncode (void)

DESCRIPTION

This routine is to get browser accept encode (HTTP_ACCEPT_ENCODING).

RETURN

pointer to the accept encode, otherwise "" if not found

SEE ALSO

ebenviron


eyBuildLib : Routines

getHttpETag( )

NAME

getHttpETag( ) - get HTTP entity tag (HTTP_IF_NONE_MATCH)

SYNOPSIS

char * getHttpETag (void)

DESCRIPTION

This routine is to get HTTP entity tag (HTTP_IF_NONE_MATCH).

RETURN

pointer to the entity tag, otherwise "" if not found

SEE ALSO

ebenviron