Mailing List Archive

jim 98/04/14 16:07:42

Modified: . API-dict.html
Log:
Start linking and describing

Revision Changes Path
1.12 +117 -65 apache-devsite/API-dict.html

Index: API-dict.html
===================================================================
RCS file: /export/home/cvs/apache-devsite/API-dict.html,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- API-dict.html 1998/04/13 12:30:10 1.11
+++ API-dict.html 1998/04/14 23:07:41 1.12
@@ -134,8 +134,9 @@
<HR>
<H3><A NAME="ap_add_per_dir_conf"><SAMP>ap_add_per_dir_conf</SAMP></A></H3>
<PRE>
- void ap_add_per_dir_conf(server_rec *s, void *dir_config)
+ void ap_add_per_dir_conf(<A HREF="#server_rec">server_rec</A> *s, void *dir_config)
</PRE>
+
<P>
definition/description
<BR>
@@ -144,8 +145,9 @@
<HR>
<H3><A NAME="ap_add_per_url_conf"><SAMP>ap_add_per_url_conf</SAMP></A></H3>
<PRE>
- void ap_add_per_url_conf(server_rec *s, void *url_config)
+ void ap_add_per_url_conf(<A HREF="#server_rec">server_rec</A> *s, void *url_config)
</PRE>
+
<P>
definition/description
<BR>
@@ -162,7 +164,7 @@
<HR>
<H3><A NAME="ap_allow_overrides"><SAMP>ap_allow_overrides</SAMP></A></H3>
<PRE>
- int ap_allow_overrides (request_rec *);
+ int ap_allow_overrides (<A HREF="#request_rec">request_rec</A> *);
</PRE>
<P>
definition/description
@@ -173,7 +175,7 @@
char *ap_cpystrn(char *buf, const char *str, size_t numbytes)
</PRE>
<P>
- definition/description
+ Copies at most <CODE>numbytes</CODE> of <CODE>str</CODE> to<CODE> buf</CODE>. Differs from <CODE>strncpy()</CODE> in that <CODE>buf</CODE> is always null terminated, but is not null filled. Returns a pointer to the terminating <CODE>'\0</CODE>'
</P>
<HR>
<H3><A NAME="ap_escape_quotes"><SAMP>ap_escape_quotes</SAMP></A></H3>
@@ -210,11 +212,11 @@
<HR>
<H3><A NAME="ap_snprintf"><SAMP>ap_snprintf</SAMP></A></H3>
<PRE>
- prototype
+ (int) ap_snprintf(char *buf, size_t len, const char *format,...)
</PRE>
<P>
- definition/description
- </P>
+ Apache enhanced version of standard <CODE>snprint()</CODE> function.
+Differs from <CODE>snprintf()</CODE> in that <CODE>buf</CODE> is always null terminated and that a value of 0 for <CODE>len</CODE> causes it to return NULL. </P>
<HR>
<H3><A NAME="ap_vformatter"><SAMP>ap_vformatter</SAMP></A></H3>
<PRE>
@@ -229,23 +231,23 @@
int ap_vsnprintf(char *buf, size_t numbytes, const char *fmt, va_list ap)
</PRE>
<P>
- definition/description
- </P>
+ Apache enhanced version of standard <CODE>vsnprint()</CODE> function.
+Differs from <CODE>vsnprintf()</CODE> in that <CODE>buf</CODE> is always null terminated and that a value of 0 for <CODE>len</CODE> causes it to return NULL. </P>
<HR>
<H3><A NAME="ap_get_server_built"><SAMP>ap_get_server_built</SAMP></A></H3>
<PRE>
- prototype
+ (const char *) ap_get_server_built(void)
</PRE>
<P>
- definition/description
+ Returns a pointer to a string defining the build-date of the executable image, e.g.: <CODE>Apr 13 1998 22:01:36</CODE>
</P>
<HR>
<H3><A NAME="ap_get_server_version"><SAMP>ap_get_server_version</SAMP></A></H3>
<PRE>
- prototype
+ (const char *) ap_get_server_version(void)
</PRE>
- <P>
- definition/description
+<P>
+ Returns a pointer to a string defining the official server version, e.g.: <CODE>Apache/1.3.0 PHP/3.0</CODE>
</P>
<HR>
<H3><A NAME="ap_log_error"><SAMP>ap_log_error</SAMP></A></H3>
@@ -258,8 +260,9 @@
<HR>
<H3><A NAME="ap_append_arrays"><SAMP>ap_append_arrays</SAMP></A></H3>
<PRE>
- array_header *ap_append_arrays(pool *, const array_header *,
+ array_header *ap_append_arrays(<A HREF="#pool">pool</A> *, const array_header *,
</PRE>
+
<P>
definition/description
</P>
@@ -274,96 +277,108 @@
<HR>
<H3><A NAME="ap_auth_name"><SAMP>ap_auth_name</SAMP></A></H3>
<PRE>
- char *ap_auth_name (request_rec *)
+ char *ap_auth_name (<A HREF="#request_rec">request_rec</A> *)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_auth_type"><SAMP>ap_auth_type</SAMP></A></H3>
<PRE>
- char *ap_auth_type (request_rec *)
+ char *ap_auth_type (<A HREF="#request_rec">request_rec</A> *)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_basic_http_header"><SAMP>ap_basic_http_header</SAMP></A></H3>
<PRE>
- void ap_basic_http_header(request_rec *r)
+ void ap_basic_http_header(<A HREF="#request_rec">request_rec</A> *r)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_bclose"><SAMP>ap_bclose</SAMP></A></H3>
<PRE>
- int ap_bclose(BUFF *fb)
+ int ap_bclose(<A HREF="#BUFF">BUFF</A> *fb)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_bcreate"><SAMP>ap_bcreate</SAMP></A></H3>
<PRE>
- BUFF *ap_bcreate(pool *p, int flags)
+ BUFF *ap_bcreate(<A HREF="#pool">pool</A> *p, int flags)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_bfilbuf"><SAMP>ap_bfilbuf</SAMP></A></H3>
<PRE>
- int ap_bfilbuf(BUFF *fb)
+ int ap_bfilbuf(<A HREF="#BUFF">BUFF</A> *fb)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_bfileno"><SAMP>ap_bfileno</SAMP></A></H3>
<PRE>
- int ap_bfileno(BUFF *fb, int direction)
+ int ap_bfileno(<A HREF="#BUFF">BUFF</A> *fb, int direction)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_bflsbuf"><SAMP>ap_bflsbuf</SAMP></A></H3>
<PRE>
- int ap_bflsbuf(int c, BUFF *fb)
+ int ap_bflsbuf(int c, <A HREF="#BUFF">BUFF</A> *fb)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_bflush"><SAMP>ap_bflush</SAMP></A></H3>
<PRE>
- int ap_bflush(BUFF *fb)
+ int ap_bflush(<A HREF="#BUFF">BUFF</A> *fb)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_bgetopt"><SAMP>ap_bgetopt</SAMP></A></H3>
<PRE>
- int ap_bgetopt(BUFF *fb, int optname, void *optval)
+ int ap_bgetopt(<A HREF="#BUFF">BUFF</A> *fb, int optname, void *optval)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_bgets"><SAMP>ap_bgets</SAMP></A></H3>
<PRE>
- int ap_bgets(char *s, int n, BUFF *fb)
+ int ap_bgets(char *s, int n, <A HREF="#BUFF">BUFF</A> *fb)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_bhalfduplex"><SAMP>ap_bhalfduplex</SAMP></A></H3>
<PRE>
- void ap_bhalfduplex(BUFF *fb)
+ void ap_bhalfduplex(<A HREF="#BUFF">BUFF</A> *fb)
</PRE>
+
<P>
definition/description
</P>
@@ -378,80 +393,90 @@
<HR>
<H3><A NAME="ap_blookc"><SAMP>ap_blookc</SAMP></A></H3>
<PRE>
- int ap_blookc(char *buff, BUFF *fb)
+ int ap_blookc(char *buff, <A HREF="#BUFF">BUFF</A> *fb)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_bnonblock"><SAMP>ap_bnonblock</SAMP></A></H3>
<PRE>
- int ap_bnonblock(BUFF *fb, int direction)
+ int ap_bnonblock(<A HREF="#BUFF">BUFF</A> *fb, int direction)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_bonerror"><SAMP>ap_bonerror</SAMP></A></H3>
<PRE>
- void ap_bonerror(BUFF *fb, void (*error) (BUFF *, int, void *),
+ void ap_bonerror(BUFF *fb, void (*error) (<A HREF="#BUFF">BUFF</A> *, int, void *),
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_bpushfd"><SAMP>ap_bpushfd</SAMP></A></H3>
<PRE>
- void ap_bpushfd(BUFF *fb, int fd_in, int fd_out)
+ void ap_bpushfd(<A HREF="#BUFF">BUFF</A> *fb, int fd_in, int fd_out)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_bputs"><SAMP>ap_bputs</SAMP></A></H3>
<PRE>
- int ap_bputs(const char *x, BUFF *fb)
+ int ap_bputs(const char *x, <A HREF="#BUFF">BUFF</A> *fb)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_bread"><SAMP>ap_bread</SAMP></A></H3>
<PRE>
- int ap_bread(BUFF *fb, void *buf, int nbyte)
+ int ap_bread(<A HREF="#BUFF">BUFF</A> *fb, void *buf, int nbyte)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_bsetflag"><SAMP>ap_bsetflag</SAMP></A></H3>
<PRE>
- int ap_bsetflag(BUFF *fb, int flag, int value)
+ int ap_bsetflag(<A HREF="#BUFF">BUFF</A> *fb, int flag, int value)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_bsetopt"><SAMP>ap_bsetopt</SAMP></A></H3>
<PRE>
- int ap_bsetopt(BUFF *fb, int optname, const void *optval)
+ int ap_bsetopt(<A HREF="#BUFF">BUFF</A> *fb, int optname, const void *optval)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_bskiplf"><SAMP>ap_bskiplf</SAMP></A></H3>
<PRE>
- int ap_bskiplf(BUFF *fb)
+ int ap_bskiplf(<A HREF="#BUFF">BUFF</A> *fb)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_bvputs"><SAMP>ap_bvputs</SAMP></A></H3>
<PRE>
- int ap_bvputs(BUFF *fb, ...)
+ int ap_bvputs(<A HREF="#BUFF">BUFF</A> *fb, ...)
</PRE>
+
<P>
definition/description
<BR>
@@ -460,8 +485,9 @@
<HR>
<H3><A NAME="ap_bwrite"><SAMP>ap_bwrite</SAMP></A></H3>
<PRE>
- int ap_bwrite(BUFF *fb, const void *buf, int nbyte)
+ int ap_bwrite(<A HREF="#BUFF">BUFF</A> *fb, const void *buf, int nbyte)
</PRE>
+
<P>
definition/description
</P>
@@ -476,8 +502,9 @@
<HR>
<H3><A NAME="ap_bytes_in_pool"><SAMP>ap_bytes_in_pool</SAMP></A></H3>
<PRE>
- long ap_bytes_in_pool(pool *p)
+ long ap_bytes_in_pool(<A HREF="#pool">pool</A> *p)
</PRE>
+
<P>
definition/description
</P>
@@ -496,8 +523,9 @@
<HR>
<H3><A NAME="ap_call_exec"><SAMP>ap_call_exec</SAMP></A></H3>
<PRE>
- int ap_call_exec(request_rec *r, char *argv0, char **env,
+ int ap_call_exec(<A HREF="#request_rec">request_rec</A> *r, char *argv0, char **env,
</PRE>
+
<P>
definition/description
</P>
@@ -632,8 +660,9 @@
<HR>
<H3><A NAME="ap_clear_pool"><SAMP>ap_clear_pool</SAMP></A></H3>
<PRE>
- void ap_clear_pool(struct pool *p)
+ void ap_clear_pool(struct <A HREF="#pool">pool</A> *p)
</PRE>
+
<P>
definition/description
</P>
@@ -684,24 +713,27 @@
<HR>
<H3><A NAME="ap_copy_array"><SAMP>ap_copy_array</SAMP></A></H3>
<PRE>
- array_header *ap_copy_array(pool *p, const array_header *src)
+ array_header *ap_copy_array(pool *p, const <A HREF="#array_header">array_header</A> *src)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_copy_array_hdr"><SAMP>ap_copy_array_hdr</SAMP></A></H3>
<PRE>
- array_header *ap_copy_array_hdr(pool *p, const array_header *src)
+ array_header *ap_copy_array_hdr(<A HREF="#pool">pool</A> *p, const <A HREF="#array_header">array_header</A> *src)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_copy_table"><SAMP>ap_copy_table</SAMP></A></H3>
<PRE>
- table *ap_copy_table(pool *p, const table *)
+ table *ap_copy_table(<A HREF="#pool">pool</A> *p, const <A HREF="#table">table</A> *)
</PRE>
+
<P>
definition/description
</P>
@@ -724,16 +756,20 @@
<HR>
<H3><A NAME="ap_create_environment"><SAMP>ap_create_environment</SAMP></A></H3>
<PRE>
- char **ap_create_environment(pool *p, table *t)
+ char **ap_create_environment(<A HREF="#pool">pool</A> *p, <A HREF="#table">table</A> *t)
</PRE>
- <P>
- definition/description
- </P>
+
+
+
+<P>
+ Creates and returns a safe <CODE>**envp</CODE>, usually for use by <CODE><A HREF="#ap_call_exec">ap_call_exec()</A></CODE>. The environment created consists of <CODE>TZ</CODE>, variables set by<CODE> SetEnv</CODE>, passed by <CODE>PassEnv</CODE> and HTTP specific variables (eg: <CODE>DOCUMENT_ROOT</CODE>).</P>
<HR>
<H3><A NAME="ap_create_per_dir_config"><SAMP>ap_create_per_dir_config</SAMP></A></H3>
+
<PRE>
- void *ap_create_per_dir_config(pool *p)
+ void *ap_create_per_dir_config(<A HREF="#pool">pool</A> *p)
</PRE>
+
<P>
definition/description
<BR>
@@ -796,8 +832,9 @@
<HR>
<H3><A NAME="ap_destroy_sub_req"><SAMP>ap_destroy_sub_req</SAMP></A></H3>
<PRE>
- void ap_destroy_sub_req(request_rec *r)
+ void ap_destroy_sub_req(<A HREF="#request_rec">request_rec</A> *r)
</PRE>
+
<P>
definition/description
</P>
@@ -812,48 +849,54 @@
<HR>
<H3><A NAME="ap_discard_request_body"><SAMP>ap_discard_request_body</SAMP></A></H3>
<PRE>
- int ap_discard_request_body(request_rec *r)
+ int ap_discard_request_body(<A HREF="#request_rec">request_rec</A> *r)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_document_root"><SAMP>ap_document_root</SAMP></A></H3>
<PRE>
- char *ap_document_root(request_rec *)
+ char *ap_document_root(<A HREF="#request_rec">request_rec</A> *)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_each_byterange"><SAMP>ap_each_byterange</SAMP></A></H3>
<PRE>
- int ap_each_byterange(request_rec *r, long *offset, long *length)
+ int ap_each_byterange(<A HREF="#request_rec">request_rec</A> *r, long *offset, long *length)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_error_log2stderr"><SAMP>ap_error_log2stderr</SAMP></A></H3>
<PRE>
- void ap_error_log2stderr(server_rec *)
+ void ap_error_log2stderr(<A HREF="#server_rec">server_rec</A> *)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_escape_html"><SAMP>ap_escape_html</SAMP></A></H3>
<PRE>
- char *ap_escape_html(pool *p, const char *s)
+ char *ap_escape_html(<A HREF="#pool">pool</A> *p, const char *s)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_escape_path_segment"><SAMP>ap_escape_path_segment</SAMP></A></H3>
<PRE>
- char *ap_escape_path_segment(pool *p, const char *s)
+ char *ap_escape_path_segment(<A HREF="#pool">pool</A> *p, const char *s)
</PRE>
+
<P>
definition/description
</P>
@@ -892,8 +935,9 @@
<HR>
<H3><A NAME="ap_find_command"><SAMP>ap_find_command</SAMP></A></H3>
<PRE>
- const command_rec *ap_find_command(const char *name, const command_rec *cmds)
+ const command_rec *ap_find_command(const char *name, const <A HREF="#command_rec">command_rec</A> *cmds)
</PRE>
+
<P>
definition/description
<BR>
@@ -902,8 +946,9 @@
<HR>
<H3><A NAME="ap_find_command_in_modules"><SAMP>ap_find_command_in_modules</SAMP></A></H3>
<PRE>
- const command_rec *ap_find_command_in_modules(const char *cmd_name, module **m)
+ const command_rec *ap_find_command_in_modules(const char *cmd_name, <A HREF="#module">module</A> **m)
</PRE>
+
<P>
definition/description
<BR>
@@ -928,8 +973,9 @@
<HR>
<H3><A NAME="ap_find_module_name"><SAMP>ap_find_module_name</SAMP></A></H3>
<PRE>
- const char *ap_find_module_name(module *m)
+ const char *ap_find_module_name(<A HREF="#module">module</A> *m)
</PRE>
+
<P>
definition/description
</P>
@@ -963,8 +1009,9 @@
<HR>
<H3><A NAME="ap_find_token"><SAMP>ap_find_token</SAMP></A></H3>
<PRE>
- int ap_find_token(pool *p, const char *line, const char *tok)
+ int ap_find_token(<A HREF="#pool">pool</A> *p, const char *line, const char *tok)
</PRE>
+
<P>
definition/description
</P>
@@ -1011,8 +1058,9 @@
<HR>
<H3><A NAME="ap_get_client_block"><SAMP>ap_get_client_block</SAMP></A></H3>
<PRE>
- long ap_get_client_block(request_rec *r, char *buffer, int bufsiz)
+ long ap_get_client_block(<A HREF="#request_rec">request_rec</A> *r, char *buffer, int bufsiz)
</PRE>
+
<P>
definition/description
</P>
@@ -1043,32 +1091,36 @@
<HR>
<H3><A NAME="ap_get_remote_host"><SAMP>ap_get_remote_host</SAMP></A></H3>
<PRE>
- const char *ap_get_remote_host(conn_rec *conn, void *dir_config, int type)
+ const char *ap_get_remote_host(<A HREF="#conn_rec">conn_rec</A> *conn, void *dir_config, int type)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_get_remote_logname"><SAMP>ap_get_remote_logname</SAMP></A></H3>
<PRE>
- const char *ap_get_remote_logname(request_rec *r)
+ const char *ap_get_remote_logname(<A HREF="#request_rec">request_rec</A> *r)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_get_server_name"><SAMP>ap_get_server_name</SAMP></A></H3>
<PRE>
- const char *ap_get_server_name(const request_rec *r)
+ const char *ap_get_server_name(const <A HREF="#request_rec" TARGET="">request_rec</A> *r)
</PRE>
+
<P>
definition/description
</P>
<HR>
<H3><A NAME="ap_get_server_port"><SAMP>ap_get_server_port</SAMP></A></H3>
<PRE>
- unsigned ap_get_server_port(const request_rec *r)
+ unsigned ap_get_server_port(const <A HREF="#request_rec" TARGET="">request_rec</A> *r)
</PRE>
+
<P>
definition/description
</P>