globus_common
Globus Common API Common Data Structures and Functions.
- Provided by: libglobus-common-doc (Version: 16.0-2)
- Source: globus-common
- Report a bug
Globus Common API Common Data Structures and Functions.
#define GLOBUS_COMMON_MODULE (&globus_i_common_module)
Globus Common Module Descriptor. #define GLOBUS_TILDE_EXPAND
Expand ~. #define GLOBUS_TILDE_USER_EXPAND
Expand ~user. #define GLOBUS_TRUE 1
True value for globus_bool_t. #define GLOBUS_FALSE 0
False value for globus_bool_t. #define GLOBUS_SUCCESS 0
Generic success result
Most Globus API functions return this value to indicate success,
or some error constant or globus_result_t to indicate an error.
" #define GLOBUS_FAILURE -1
Generic failure result
Some Globus API functions without good error handling return this
value to indicate some undetermined error occurred. "
typedef size_t globus_size_t
Standard size of memory object
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. "
typedef socklen_t globus_socklen_t
Size of a socket length parameter. typedef unsigned char
globus_byte_t
Unsigned byte datatype
This is used for byte-addressable arrays of arbitrary data which
is not subject to sign extension. " typedef int
globus_bool_t
Boolean type. typedef uint32_t globus_result_t
globus_result_t globus_eval_path (const char
*pathstring, char **bufp)
int globus_tilde_expand (unsigned long options, globus_bool_t
url_form, char *inpath, char **outpath)
Expand ~ and/or ~user in path strings.
Common Data Structures and Functions.
Boolean type. Set values to either the constant GLOBUS_TRUE and GLOBUS_FALSE
Weak pointer to a Globus Error object, or the special value GLOBUS_SUCCESS
Size of a socket length parameter. The globus_socklen_t type is part of the POSIX socket interface and is also available in winsock2.h. In older UNIX implementations, this was variously a size_t or an int.
Parameters:
bufp Pointer to be set to a newly allocated string that has recursively resolved all substitution paths.
Expand ~ and/or ~user in path strings. Expand the leading ~ (or ~user) characters from inpath to the home directory path of the current user (or user specified in ~user); the result is stored in a newly allocated buffer *outpath (which will need to be freed by a call to globus_free.) The string following the ~/or ~user/ is copied verbatim to the output string.
Parameters:
url_form True if the inpath follows an URL format (/~) Used
when expanding an url (for : <scheme>://host[:port][/path] were /path
can be of the form /~[user][/...]. Otherwise, the form ~[user][/...] is
expected.
inpath Input string to expand.
outpath Output string; Need to be freed when not used anymore.
Generated automatically by Doxygen for globus_common from the source code.