.TH "globus_types.h" 3 "Version 18.14" "globus_common" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_types.h \- Common Primitive Types\&.  

.SH SYNOPSIS
.br
.PP
\fC#include 'globus_config\&.h'\fP
.br
\fC#include <stdlib\&.h>\fP
.br
\fC#include <stdint\&.h>\fP
.br
\fC#include <sys/types\&.h>\fP
.br
\fC#include <sys/socket\&.h>\fP
.br

.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBGLOBUS_TRUE\fP   1"
.br
.RI "True value for globus_bool_t\&. "
.ti -1c
.RI "#define \fBGLOBUS_FALSE\fP   0"
.br
.RI "False value for globus_bool_t\&. "
.ti -1c
.RI "#define \fBGLOBUS_NULL\fP   NULL"
.br
.RI "NULL value\&. "
.ti -1c
.RI "#define \fBGLOBUS_SUCCESS\fP   0"
.br
.RI "Generic success result
.PP
Most Globus API functions return this value to indicate success, or some error constant or globus_result_t to indicate an error\&. "
.ti -1c
.RI "#define \fBGLOBUS_FAILURE\fP   \-1"
.br
.RI "Generic failure result
.PP
Some Globus API functions without good error handling return this value to indicate some undetermined error occurred\&. "
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef size_t \fBglobus_size_t\fP"
.br
.RI "Standard size of memory object
.PP
The globus_size_t is the size of a memory object\&. It is identical to size_t in all cases and doesn't need to be used ever\&. "
.ti -1c
.RI "typedef socklen_t \fBglobus_socklen_t\fP"
.br
.RI "Size of a socket length parameter\&. "
.ti -1c
.RI "typedef unsigned char \fBglobus_byte_t\fP"
.br
.RI "Unsigned byte datatype
.PP
This is used for byte-addressable arrays of arbitrary data which is not subject to sign extension\&. "
.ti -1c
.RI "typedef int \fBglobus_bool_t\fP"
.br
.RI "Boolean type\&. "
.ti -1c
.RI "typedef uint32_t \fBglobus_result_t\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Common Primitive Types\&. 

Defines the macros and typedefs common to all globus_common components\&. 
.SH "Macro Definition Documentation"
.PP 
.SS "#define GLOBUS_NULL   NULL"

.PP
NULL value\&. From back long ago before NULL was standardized? No reason to use this on any modern system\&. 
.SH "Author"
.PP 
Generated automatically by Doxygen for globus_common from the source code\&.