Return-Path: Delivered-To: apmail-apr-commits-archive@www.apache.org Received: (qmail 81572 invoked from network); 15 Jun 2009 00:03:56 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.3) by minotaur.apache.org with SMTP; 15 Jun 2009 00:03:56 -0000 Received: (qmail 33827 invoked by uid 500); 15 Jun 2009 00:04:08 -0000 Delivered-To: apmail-apr-commits-archive@apr.apache.org Received: (qmail 33760 invoked by uid 500); 15 Jun 2009 00:04:08 -0000 Mailing-List: contact commits-help@apr.apache.org; run by ezmlm Precedence: bulk List-Post: List-Help: List-Unsubscribe: Reply-To: dev@apr.apache.org List-Id: Delivered-To: mailing list commits@apr.apache.org Received: (qmail 33751 invoked by uid 99); 15 Jun 2009 00:04:07 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 15 Jun 2009 00:04:07 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 15 Jun 2009 00:03:55 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 6AFC82388A29; Mon, 15 Jun 2009 00:02:05 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r784636 [36/47] - in /apr/site/trunk/docs/docs: apr-util/trunk/ apr/trunk/ Date: Mon, 15 Jun 2009 00:01:47 -0000 To: commits@apr.apache.org From: bojan@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20090615000205.6AFC82388A29@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: apr/site/trunk/docs/docs/apr/trunk/group___a_p_r___util___d_b_m.html URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/group___a_p_r___util___d_b_m.html?rev=784636&view=auto ============================================================================== --- apr/site/trunk/docs/docs/apr/trunk/group___a_p_r___util___d_b_m.html (added) +++ apr/site/trunk/docs/docs/apr/trunk/group___a_p_r___util___d_b_m.html Mon Jun 15 00:01:38 2009 @@ -0,0 +1,489 @@ + + +Apache Portable Runtime: DBM routines + + + + + +
+

DBM routines
+ +[APR Utility Functions] +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  apr_datum_t

Modules

 SDBM library

Defines

#define APR_DBM_READONLY   1
#define APR_DBM_READWRITE   2
#define APR_DBM_RWCREATE   3
#define APR_DBM_RWTRUNC   4

Typedefs

typedef struct apr_dbm_t apr_dbm_t

Functions

 APU_DECLARE (apr_status_t) apr_dbm_open_ex(apr_dbm_t **dbm
 APU_DECLARE (void) apr_dbm_close(apr_dbm_t *dbm)
 APU_DECLARE (char *) apr_dbm_geterror(apr_dbm_t *dbm

Variables

+const char * type
+const char const char * name
+const char const char apr_int32_t mode
+const char const char
+apr_int32_t apr_fileperms_t 		perm
+const char const char
+apr_int32_t apr_fileperms_t
+apr_pool_t * 		cntxt
+apr_datum_t key
+apr_datum_t apr_datum_t * pvalue
+apr_datum_t apr_datum_t value
+apr_datum_t * pkey
+apr_datum_t data
+int * errcode
+int char * errbuf
+int char apr_size_t errbufsize
+const char const char * pathname
+const char const char const char ** used1
+const char const char const
+char const char ** 		used2
+

Define Documentation

+ +
+
+ + + + +
#define APR_DBM_READONLY   1
+
+
+ +

+open for read-only access +

+

+ +

+
+ + + + +
#define APR_DBM_READWRITE   2
+
+
+ +

+open for read-write access +

+

+ +

+
+ + + + +
#define APR_DBM_RWCREATE   3
+
+
+ +

+open for r/w, create if needed +

+

+ +

+
+ + + + +
#define APR_DBM_RWTRUNC   4
+
+
+ +

+open for r/w, truncating an existing DB if present +

+

+

Typedef Documentation

+ +
+
+ + + + +
typedef struct apr_dbm_t apr_dbm_t
+
+
+ +

+Structure for referencing a dbm +

+

+

Function Documentation

+ +
+
+ + + + + + + + + +
APU_DECLARE (char *   ) 
+
+
+ +

+Report more information when an apr_dbm function fails.

Parameters:
+ + + + + +
dbm The database
errcode A DBM-specific value for the error (for logging). If this isn't needed, it may be NULL.
errbuf Location to store the error text
errbufsize The size of the provided buffer
+
+
Returns:
The errbuf parameter, for convenience.
+ +
+

+ +

+
+ + + + + + + + + +
APU_DECLARE (void   ) 
+
+
+ +

+Close a dbm file previously opened by apr_dbm_open

Parameters:
+ + +
dbm The database to close
+
+Proactively toss any memory associated with the apr_datum_t.
Parameters:
+ + + +
dbm The database
data The datum to free.
+
+If the specified file/path were passed to apr_dbm_open(), return the actual file/path names which would be (created and) used. At most, two files may be used; used2 may be NULL if only one file is used.
Parameters:
+ + + + + +
pool The pool for allocating used1 and used2.
pathname The path name to generate used-names from.
used1 The first pathname used by the apr_dbm implementation.
used2 The second pathname used by apr_dbm. If only one file is used by the specific implementation, this will be set to NULL.
+
+
Remarks:
The dbm file(s) don't need to exist. This function only manipulates the pathnames.
+Sort all of the registerd functions for a given hook

+Print all of the information about the current hook. This is used for debugging purposes.

Parameters:
+ + + + +
szName The name of the hook
aszPre All of the functions in the predecessor array
aszSucc All of the functions in the successor array
+
+Remove all currently registered functions.

+Set reslist cleanup order.

Parameters:
+ + + +
reslist The resource list.
mode Cleanup order mode 
+           APR_RESLIST_CLEANUP_DEFAULT  default pool cleanup order
+           APR_RESLIST_CLEANUP_FIRST    use pool pre cleanup
+
+
+
Remarks:
If APR_RESLIST_CLEANUP_FIRST is used the destructors will be called before child pools of the pool used to create the reslist are destroyed. This allows to explicitly destroy the child pools inside reslist destructors.
+Initialize the SHA digest
Parameters:
+ + +
context The SHA context to initialize
+
+Update the SHA digest
Parameters:
+ + + + +
context The SHA1 context to update
input The buffer to add to the SHA digest
inputLen The length of the input buffer
+
+Update the SHA digest with binary data
Parameters:
+ + + + +
context The SHA1 context to update
input The buffer to add to the SHA digest
inputLen The length of the input buffer
+
+Finish computing the SHA digest
Parameters:
+ + + +
digest the output buffer in which to store the digest
context The context to finalize
+
+Format a UUID into a string, following the standard format
Parameters:
+ + + +
buffer The buffer to place the formatted UUID string into. It must be at least APR_UUID_FORMATTED_LENGTH + 1 bytes long to hold the formatted UUID and a null terminator
uuid The UUID to format
+
+Converts an XML element tree to flat text
Parameters:
+ + + + + + + + +
p The pool to allocate out of
elem The XML element to convert
style How to covert the XML. One of: 
+     APR_XML_X2T_FULL                start tag, contents, end tag 
+     APR_XML_X2T_INNER               contents only 
+     APR_XML_X2T_LANG_INNER          xml:lang + inner contents 
+     APR_XML_X2T_FULL_NS_LANG        FULL + ns defns + xml:lang 
+
namespaces The namespace of the current XML element
ns_map Namespace mapping
pbuf Buffer to put the converted text into
psize Size of the converted text
+
+Quote an XML element
Parameters:
+ + + +
p The pool to allocate out of
elem The element to quote
+
+Set the timeout the acquire will wait for a free resource when the maximum number of resources is exceeded.
Parameters:
+ + + +
reslist The resource list.
timeout Timeout to wait. The zero waits forever.
+
+Set reslist cleanup order.
Parameters:
+ + + +
reslist The resource list.
mode Cleanup order mode 
+           APR_RESLIST_CLEANUP_DEFAULT  default pool cleanup order
+           APR_RESLIST_CLEANUP_FIRST    use pool pre cleanup
+
+
+
Remarks:
If APR_RESLIST_CLEANUP_FIRST is used the destructors will be called before child pools of the pool used to create the reslist are destroyed. This allows to explicitly destroy the child pools inside reslist destructors.
+Append a piece of text to the end of a list
Parameters:
+ + + + +
p The pool to allocate out of
hdr The text header to append to
text The new text to append
+
+Converts an XML element tree to flat text
Parameters:
+ + + + + + + + +
p The pool to allocate out of
elem The XML element to convert
style How to covert the XML. One of: 
+     APR_XML_X2T_FULL                start tag, contents, end tag 
+     APR_XML_X2T_INNER               contents only 
+     APR_XML_X2T_LANG_INNER          xml:lang + inner contents 
+     APR_XML_X2T_FULL_NS_LANG        FULL + ns defns + xml:lang 
+
namespaces The namespace of the current XML element
ns_map Namespace mapping
pbuf Buffer to put the converted text into
psize Size of the converted text
+
+Quote an XML element
Parameters:
+ + + +
p The pool to allocate out of
elem The element to quote
+
+ +
+

+ +

+
+ + + + + + + + + +
APU_DECLARE (apr_status_t   ) 
+
+
+ +

+Open a dbm file by file name and type of DBM

Parameters:
+ + + + + + + +
dbm The newly opened database
type The type of the DBM (not all may be available at run time) 
+  db   for Berkeley DB files
+  gdbm for GDBM files
+  ndbm for NDBM files
+  sdbm for SDBM files (always available)
+  default for the default DBM type
+
name The dbm file name to open
mode The flag value 
+           APR_DBM_READONLY   open for read-only access
+           APR_DBM_READWRITE  open for read-write access
+           APR_DBM_RWCREATE   open for r/w, create if needed
+           APR_DBM_RWTRUNC    open for r/w, truncate if already there
+
perm Permissions to apply to if created
cntxt The pool to use when creating the dbm
+
+
Remarks:
The dbm name may not be a true file name, as many dbm packages append suffixes for seperate data and index files.
+
Bug:
In apr-util 0.9 and 1.x, the type arg was case insensitive. This was highly inefficient, and as of 2.x the dbm name must be provided in the correct case (lower case for all bundled providers)
+

+Open a dbm file by file name

Parameters:
+ + + + + + +
dbm The newly opened database
name The dbm file name to open
mode The flag value 
+           APR_DBM_READONLY   open for read-only access
+           APR_DBM_READWRITE  open for read-write access
+           APR_DBM_RWCREATE   open for r/w, create if needed
+           APR_DBM_RWTRUNC    open for r/w, truncate if already there
+
perm Permissions to apply to if created
cntxt The pool to use when creating the dbm
+
+
Remarks:
The dbm name may not be a true file name, as many dbm packages append suffixes for seperate data and index files.
+Fetch a dbm record value by key
Parameters:
+ + + + +
dbm The database
key The key datum to find this record
pvalue The value datum retrieved for this record
+
+Store a dbm record value by key
Parameters:
+ + + + +
dbm The database
key The key datum to store this record by
value The value datum to store in this record
+
+Delete a dbm record value by key
Parameters:
+ + + +
dbm The database
key The key datum of the record to delete
+
+
Remarks:
It is not an error to delete a non-existent record.
+Search for a key within the dbm
Parameters:
+ + + +
dbm The database
key The datum describing a key to test
+
+Retrieve the first record key from a dbm
Parameters:
+ + + +
dbm The database
pkey The key datum of the first record
+
+Retrieve the next record key from a dbm
Parameters:
+ + + +
dbm The database
pkey The key datum of the next record
+
+If the specified file/path were passed to apr_dbm_open(), return the actual file/path names which would be (created and) used. At most, two files may be used; used2 may be NULL if only one file is used.
Parameters:
+ + + +
pool The pool for allocating used1 and used2.
type The type of DBM you require info on
+
+
See also:
apr_dbm_open_ex
+
Parameters:
+ + + + +
pathname The path name to generate used-names from.
used1 The first pathname used by the apr_dbm implementation.
used2 The second pathname used by apr_dbm. If only one file is used by the specific implementation, this will be set to NULL.
+
+
Returns:
An error if the specified type is invalid.
+
Remarks:
The dbm file(s) don't need to exist. This function only manipulates the pathnames.
+ +
+

+

+
Generated on Mon Jun 15 09:45:29 2009 for Apache Portable Runtime by  + +doxygen 1.5.8
+ + Added: apr/site/trunk/docs/docs/apr/trunk/group___a_p_r___util___d_b_m___s_d_b_m.html URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/group___a_p_r___util___d_b_m___s_d_b_m.html?rev=784636&view=auto ============================================================================== --- apr/site/trunk/docs/docs/apr/trunk/group___a_p_r___util___d_b_m___s_d_b_m.html (added) +++ apr/site/trunk/docs/docs/apr/trunk/group___a_p_r___util___d_b_m___s_d_b_m.html Mon Jun 15 00:01:38 2009 @@ -0,0 +1,274 @@ + + +Apache Portable Runtime: SDBM library + + + + + +
+

SDBM library
+ +[DBM routines] +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  apr_sdbm_datum_t

Defines

#define APR_SDBM_DIRFEXT   ".dir"
#define APR_SDBM_PAGFEXT   ".pag"
#define APR_SDBM_INSERT   0
#define APR_SDBM_REPLACE   1
#define APR_SDBM_INSERTDUP   2

Typedefs

typedef struct apr_sdbm_t apr_sdbm_t

Functions

 APU_DECLARE (apr_status_t) apr_sdbm_open(apr_sdbm_t **db

Variables

+const char * name
+const char apr_int32_t mode
+const char apr_int32_t
+apr_fileperms_t 		perms
+const char apr_int32_t
+apr_fileperms_t apr_pool_t * 		p
+int type
+apr_sdbm_datum_t * value
+apr_sdbm_datum_t apr_sdbm_datum_t key
+apr_sdbm_datum_t
+apr_sdbm_datum_t int 		opt
+

Define Documentation

+ +
+
+ + + + +
#define APR_SDBM_DIRFEXT   ".dir"
+
+
+ +

+SDBM Directory file extension +

+

+ +

+
+ + + + +
#define APR_SDBM_INSERT   0
+
+
+ +

+Insert +

+

+ +

+
+ + + + +
#define APR_SDBM_INSERTDUP   2
+
+
+ +

+Insert with duplicates +

+

+ +

+
+ + + + +
#define APR_SDBM_PAGFEXT   ".pag"
+
+
+ +

+SDBM page file extension +

+

+ +

+
+ + + + +
#define APR_SDBM_REPLACE   1
+
+
+ +

+Replace +

+

+

Typedef Documentation

+ +
+
+ + + + +
typedef struct apr_sdbm_t apr_sdbm_t
+
+
+ +

+Structure for referencing an sdbm +

+

+

Function Documentation

+ +
+
+ + + + + + + + + +
APU_DECLARE (apr_status_t   ) 
+
+
+ +

+Open an sdbm database by file name

Parameters:
+ + + + + + +
db The newly opened database
name The sdbm file to open
mode The flag values (APR_READ and APR_BINARY flags are implicit) 
+           APR_WRITE          open for read-write access
+           APR_CREATE         create the sdbm if it does not exist
+           APR_TRUNCATE       empty the contents of the sdbm
+           APR_EXCL           fail for APR_CREATE if the file exists
+           APR_DELONCLOSE     delete the sdbm when closed
+           APR_SHARELOCK      support locking across process/machines
+
perms Permissions to apply to if created
p The pool to use when creating the sdbm
+
+
Remarks:
The sdbm name is not a true file name, as sdbm appends suffixes for seperate data and index files.
+Close an sdbm file previously opened by apr_sdbm_open
Parameters:
+ + +
db The database to close
+
+Lock an sdbm database for concurency of multiple operations
Parameters:
+ + + +
db The database to lock
type The lock type 
+           APR_FLOCK_SHARED
+           APR_FLOCK_EXCLUSIVE
+
+
+
Remarks:
Calls to apr_sdbm_lock may be nested. All apr_sdbm functions perform implicit locking. Since an APR_FLOCK_SHARED lock cannot be portably promoted to an APR_FLOCK_EXCLUSIVE lock, apr_sdbm_store and apr_sdbm_delete calls will fail if an APR_FLOCK_SHARED lock is held. The apr_sdbm_lock call requires the database to be opened with the APR_SHARELOCK mode value.
+Release an sdbm lock previously aquired by apr_sdbm_lock
Parameters:
+ + +
db The database to unlock
+
+Fetch an sdbm record value by key
Parameters:
+ + + + +
db The database
value The value datum retrieved for this record
key The key datum to find this record
+
+Store an sdbm record value by key
Parameters:
+ + + + + +
db The database
key The key datum to store this record by
value The value datum to store in this record
opt The method used to store the record 
+           APR_SDBM_INSERT     return an error if the record exists
+           APR_SDBM_REPLACE    overwrite any existing record for key
+
+
+Delete an sdbm record value by key
Parameters:
+ + + +
db The database
key The key datum of the record to delete
+
+
Remarks:
It is not an error to delete a non-existent record.
+Retrieve the first record key from a dbm
Parameters:
+ + + +
db The database
key The key datum of the first record
+
+
Remarks:
The keys returned are not ordered. To traverse the list of keys for an sdbm opened with APR_SHARELOCK, the caller must use apr_sdbm_lock prior to retrieving the first record, and hold the lock until after the last call to apr_sdbm_nextkey.
+Retrieve the next record key from an sdbm
Parameters:
+ + + +
db The database
key The key datum of the next record
+
+Returns true if the sdbm database opened for read-only access
Parameters:
+ + +
db The database to test
+
+ +
+

+

+
Generated on Mon Jun 15 09:45:30 2009 for Apache Portable Runtime by  + +doxygen 1.5.8
+ + Added: apr/site/trunk/docs/docs/apr/trunk/group___a_p_r___util___date.html URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/group___a_p_r___util___date.html?rev=784636&view=auto ============================================================================== --- apr/site/trunk/docs/docs/apr/trunk/group___a_p_r___util___date.html (added) +++ apr/site/trunk/docs/docs/apr/trunk/group___a_p_r___util___date.html Mon Jun 15 00:01:38 2009 @@ -0,0 +1,146 @@ + + +Apache Portable Runtime: Date routines + + + + + +
+

Date routines
+ +[APR Utility Functions] +

+ + + + + + + + + + + + +

Defines

#define APR_DATE_BAD   ((apr_time_t)0)

Functions

 APU_DECLARE (int) apr_date_checkmask(const char *data
 APU_DECLARE (apr_time_t) apr_date_parse_http(const char *date)

Variables

+const char * mask
+

Define Documentation

+ +
+
+ + + + +
#define APR_DATE_BAD   ((apr_time_t)0)
+
+
+ +

+A bad date. +

+

+

Function Documentation

+ +
+
+ + + + + + + + + +
APU_DECLARE (apr_time_t   )  const
+
+
+ +

+Parses an HTTP date in one of three standard forms: 

+     Sun, 06 Nov 1994 08:49:37 GMT  ; RFC 822, updated by RFC 1123
+     Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036
+     Sun Nov  6 08:49:37 1994       ; ANSI C's asctime() format
+
Parameters:
+ + +
date The date in one of the three formats above
+
+
Returns:
the apr_time_t number of microseconds since 1 Jan 1970 GMT, or 0 if this would be out of range or if the date is invalid.
+Parses a string resembling an RFC 822 date. This is meant to be leinent in its parsing of dates. Hence, this will parse a wider range of dates than apr_date_parse_http.

+The prominent mailer (or poster, if mailer is unknown) that has been seen in the wild is included for the unknown formats. 

+     Sun, 06 Nov 1994 08:49:37 GMT  ; RFC 822, updated by RFC 1123
+     Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036
+     Sun Nov  6 08:49:37 1994       ; ANSI C's asctime() format
+     Sun, 6 Nov 1994 08:49:37 GMT   ; RFC 822, updated by RFC 1123
+     Sun, 06 Nov 94 08:49:37 GMT    ; RFC 822
+     Sun, 6 Nov 94 08:49:37 GMT     ; RFC 822
+     Sun, 06 Nov 94 08:49 GMT       ; Unknown [drtr@ast.cam.ac.uk] 
+     Sun, 6 Nov 94 08:49 GMT        ; Unknown [drtr@ast.cam.ac.uk]
+     Sun, 06 Nov 94 8:49:37 GMT     ; Unknown [Elm 70.85]
+     Sun, 6 Nov 94 8:49:37 GMT      ; Unknown [Elm 70.85] 
+

+

Parameters:
+ + +
date The date in one of the formats above
+
+
Returns:
the apr_time_t number of microseconds since 1 Jan 1970 GMT, or 0 if this would be out of range or if the date is invalid.
+ +
+

+ +

+
+ + + + + + + + + +
APU_DECLARE (int   )  const
+
+
+ +

+Compare a string to a mask

Parameters:
+ + + +
data The string to compare
mask Mask characters (arbitrary maximum is 256 characters): 
+   '@' - uppercase letter
+   '$' - lowercase letter
+   '&' - hex digit
+   '#' - digit
+   '~' - digit or space
+   '*' - swallow remaining characters
+
+
+
Remarks:
The mask tests for an exact match for any other character
+
Returns:
1 if the string matches, 0 otherwise
+ +
+

+

+
Generated on Mon Jun 15 09:45:29 2009 for Apache Portable Runtime by  + +doxygen 1.5.8
+ + Added: apr/site/trunk/docs/docs/apr/trunk/group___a_p_r___util___error.html URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/group___a_p_r___util___error.html?rev=784636&view=auto ============================================================================== --- apr/site/trunk/docs/docs/apr/trunk/group___a_p_r___util___error.html (added) +++ apr/site/trunk/docs/docs/apr/trunk/group___a_p_r___util___error.html Mon Jun 15 00:01:38 2009 @@ -0,0 +1,534 @@ + + +Apache Portable Runtime: APR_Util Error Values + + + + + +
+

APR_Util Error Values
+ +[Error Codes] +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Defines

#define APR_ENOKEY   (APR_UTIL_START_STATUS + 1)
#define APR_ENOIV   (APR_UTIL_START_STATUS + 2)
#define APR_EKEYTYPE   (APR_UTIL_START_STATUS + 3)
#define APR_ENOSPACE   (APR_UTIL_START_STATUS + 4)
#define APR_ECRYPT   (APR_UTIL_START_STATUS + 5)
#define APR_EPADDING   (APR_UTIL_START_STATUS + 6)
#define APR_EKEYLENGTH   (APR_UTIL_START_STATUS + 7)
#define APR_ENOCIPHER   (APR_UTIL_START_STATUS + 8)
#define APR_ENODIGEST   (APR_UTIL_START_STATUS + 9)
#define APR_ENOENGINE   (APR_UTIL_START_STATUS + 10)
#define APR_EINITENGINE   (APR_UTIL_START_STATUS + 11)
#define APR_EREINIT   (APR_UTIL_START_STATUS + 12)
#define APR_STATUS_IS_ENOKEY(s)   ((s) == APR_ENOKEY)
#define APR_STATUS_IS_ENOIV(s)   ((s) == APR_ENOIV)
#define APR_STATUS_IS_EKEYTYPE(s)   ((s) == APR_EKEYTYPE)
#define APR_STATUS_IS_ENOSPACE(s)   ((s) == APR_ENOSPACE)
#define APR_STATUS_IS_ECRYPT(s)   ((s) == APR_ECRYPT)
#define APR_STATUS_IS_EPADDING(s)   ((s) == APR_EPADDING)
#define APR_STATUS_IS_EKEYLENGTH(s)   ((s) == APR_EKEYLENGTH)
#define APR_STATUS_IS_ENOCIPHER(s)   ((s) == APR_ENOCIPHER)
#define APR_STATUS_IS_ENODIGEST(s)   ((s) == APR_ENODIGEST)
#define APR_STATUS_IS_ENOENGINE(s)   ((s) == APR_ENOENGINE)
#define APR_STATUS_IS_EINITENGINE(s)   ((s) == APR_EINITENGINE)
#define APR_STATUS_IS_EREINIT(s)   ((s) == APR_EREINIT)
+

Detailed Description

+
+ APU ERROR VALUES
+ APR_ENOKEY         The key provided was empty or NULL
+ APR_ENOIV          The initialisation vector provided was NULL
+ APR_EKEYTYPE       The key type was not recognised
+ APR_ENOSPACE       The buffer supplied was not big enough
+ APR_ECRYPT         An error occurred while encrypting or decrypting
+ APR_EPADDING       Padding was not supported
+ APR_EKEYLENGTH     The key length was incorrect
+ APR_ENOCIPHER      The cipher provided was not recognised
+ APR_ENODIGEST      The digest provided was not recognised
+ APR_ENOENGINE      The engine provided was not recognised
+ APR_EINITENGINE    The engine could not be initialised
+ APR_EREINIT        Underlying crypto has already been initialised
+

+

+ APR STATUS VALUES
+ APR_INCHILD        Program is currently executing in the child
+

Define Documentation

+ +
+
+ + + + +
#define APR_ECRYPT   (APR_UTIL_START_STATUS + 5)
+
+
+ +

+

See also:
APR_STATUS_IS_ECRYPT
+ +
+

+ +

+
+ + + + +
#define APR_EINITENGINE   (APR_UTIL_START_STATUS + 11)
+
+
+ +

+

See also:
APR_STATUS_IS_EINITENGINE
+ +
+

+ +

+
+ + + + +
#define APR_EKEYLENGTH   (APR_UTIL_START_STATUS + 7)
+
+
+ +

+

See also:
APR_STATUS_IS_EKEYLENGTH
+ +
+

+ +

+
+ + + + +
#define APR_EKEYTYPE   (APR_UTIL_START_STATUS + 3)
+
+
+ +

+

See also:
APR_STATUS_IS_EKEYTYPE
+ +
+

+ +

+
+ + + + +
#define APR_ENOCIPHER   (APR_UTIL_START_STATUS + 8)
+
+
+ +

+

See also:
APR_STATUS_IS_ENOCIPHER
+ +
+

+ +

+
+ + + + +
#define APR_ENODIGEST   (APR_UTIL_START_STATUS + 9)
+
+
+ +

+

See also:
APR_STATUS_IS_ENODIGEST
+ +
+

+ +

+
+ + + + +
#define APR_ENOENGINE   (APR_UTIL_START_STATUS + 10)
+
+
+ +

+

See also:
APR_STATUS_IS_ENOENGINE
+ +
+

+ +

+
+ + + + +
#define APR_ENOIV   (APR_UTIL_START_STATUS + 2)
+
+
+ +

+

See also:
APR_STATUS_IS_ENOIV
+ +
+

+ +

+
+ + + + +
#define APR_ENOKEY   (APR_UTIL_START_STATUS + 1)
+
+
+ +

+

See also:
APR_STATUS_IS_ENOKEY
+ +
+

+ +

+
+ + + + +
#define APR_ENOSPACE   (APR_UTIL_START_STATUS + 4)
+
+
+ +

+

See also:
APR_STATUS_IS_ENOSPACE
+ +
+

+ +

+
+ + + + +
#define APR_EPADDING   (APR_UTIL_START_STATUS + 6)
+
+
+ +

+

See also:
APR_STATUS_IS_EPADDING
+ +
+

+ +

+
+ + + + +
#define APR_EREINIT   (APR_UTIL_START_STATUS + 12)
+
+
+ +

+

See also:
APR_STATUS_IS_EREINIT
+ +
+

+ +

+
+ + + + + + + + + +
#define APR_STATUS_IS_ECRYPT (s   )    ((s) == APR_ECRYPT)
+
+
+ +

+An error occurred while encrypting or decrypting +

+

+ +

+
+ + + + + + + + + +
#define APR_STATUS_IS_EINITENGINE (s   )    ((s) == APR_EINITENGINE)
+
+
+ +

+The engine could not be initialised +

+

+ +

+
+ + + + + + + + + +
#define APR_STATUS_IS_EKEYLENGTH (s   )    ((s) == APR_EKEYLENGTH)
+
+
+ +

+An error occurred with the key length +

+

+ +

+
+ + + + + + + + + +
#define APR_STATUS_IS_EKEYTYPE (s   )    ((s) == APR_EKEYTYPE)
+
+
+ +

+The key type was not recognised +

+

+ +

+
+ + + + + + + + + +
#define APR_STATUS_IS_ENOCIPHER (s   )    ((s) == APR_ENOCIPHER)
+
+
+ +

+The cipher provided was not recognised +

+

+ +

+
+ + + + + + + + + +
#define APR_STATUS_IS_ENODIGEST (s   )    ((s) == APR_ENODIGEST)
+
+
+ +

+The digest provided was not recognised +

+

+ +

+
+ + + + + + + + + +
#define APR_STATUS_IS_ENOENGINE (s   )    ((s) == APR_ENOENGINE)
+
+
+ +

+The engine provided was not recognised +

+

+ +

+
+ + + + + + + + + +
#define APR_STATUS_IS_ENOIV (s   )    ((s) == APR_ENOIV)
+
+
+ +

+The initialisation vector was not provided +

+

+ +

+
+ + + + + + + + + +
#define APR_STATUS_IS_ENOKEY (s   )    ((s) == APR_ENOKEY)
+
+
+ +

+The key was empty or not provided +

+

+ +

+
+ + + + + + + + + +
#define APR_STATUS_IS_ENOSPACE (s   )    ((s) == APR_ENOSPACE)
+
+
+ +

+The buffer provided was not big enough +

+

+ +

+
+ + + + + + + + + +
#define APR_STATUS_IS_EPADDING (s   )    ((s) == APR_EPADDING)
+
+
+ +

+An error occurred while padding +

+

+ +

+
+ + + + + + + + + +
#define APR_STATUS_IS_EREINIT (s   )    ((s) == APR_EREINIT)
+
+
+ +

+Crypto has already been initialised +

+

+

+
Generated on Mon Jun 15 09:45:31 2009 for Apache Portable Runtime by  + +doxygen 1.5.8
+ +