Commit 9abe7044 authored by Steven Murray's avatar Steven Murray Committed by Steven Murray
Browse files

Removed the misleading statements from getconfent.man that implied the was a...

Removed the misleading statements from getconfent.man that implied the was a globally visible function.  getconfent_r can only be used from within the file CASTOR2/common/getconfent.c
parent 5bf696f9
.\" @(#)@(#)$RCSfile: getconfent.man,v $ $Revision: 1.7 $ $Date: 2007/11/30 14:17:07 $ CERN IT-PDP/DC Frederic Hemmer
.\" @(#)@(#)$RCSfile: getconfent.man,v $ $Revision: 1.8 $ $Date: 2009/03/23 14:44:18 $ CERN IT-PDP/DC Frederic Hemmer
.\" Copyright (C) 1990-2000 by CERN/IT/PDP/DC
.\" All rights reserved
.\"
.TH GETCONFENT 3 "$Date: 2007/11/30 14:17:07 $" CASTOR "Common Library Functions"
.TH GETCONFENT 3 "$Date: 2009/03/23 14:44:18 $" CASTOR "Common Library Functions"
.SH NAME
getconfent, getconfent_r \- Get configuration entry
.SH SYNOPSIS
......@@ -16,18 +16,6 @@ getconfent, getconfent_r \- Get configuration entry
.br
.BI " int " flags );
.PP
.BI "char * getconfent_r ("
.br
.BI " const char *" category ,
.br
.BI " const char *" name ,
.br
.BI " int " flags ,
.br
.BI " char *" buffer ,
.br
.BI " int " bufsiz );
.PP
.BI "int getconfent_multi ("
.br
.BI " const char *" category ,
......@@ -70,27 +58,21 @@ getconfent, getconfent_r \- Get configuration entry
.SH DESCRIPTION
.LP
.B getconfent(\|)
get the
gets the
.I name
entry from the configuration file.
Every entry in the configuration file is categorized. The
.I category
parameter is its specifier. The
.B getconfent_r(\|)
function is a re-entrant version of
.B getconfent(\|)
using the passed
.I buffer
parameter instead of an internal static buffer.
parameter is its specifier.
.PP
If threads are created usint the
.B getconfent(\|)
is thread-safe if threads are created using the
.B Cthread_create(\|)
interface, it is not mandatory to call
.B getconfent_r(\|)
in order to assure thread-safe code. In that case
interface. In this case
.B getconfent(\|)
calls the re-entrant version internally using a buffer allocated
in thread local storage.
calls the re-entrant version
.B getconfent_r(\|)
internally using a buffer allocated in thread local storage.
.PP
.B getconfent_multi(\|)
returns the
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment