Subversion: svn_user.h Source File

00001 /**
00002  * @copyright
00003  * ====================================================================
00004  *    Licensed to the Apache Software Foundation (ASF) under one
00005  *    or more contributor license agreements.  See the NOTICE file
00006  *    distributed with this work for additional information
00007  *    regarding copyright ownership.  The ASF licenses this file
00008  *    to you under the Apache License, Version 2.0 (the
00009  *    "License"); you may not use this file except in compliance
00010  *    with the License.  You may obtain a copy of the License at
00011  *
00012  *      http://www.apache.org/licenses/LICENSE-2.0
00013  *
00014  *    Unless required by applicable law or agreed to in writing,
00015  *    software distributed under the License is distributed on an
00016  *    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
00017  *    KIND, either express or implied.  See the License for the
00018  *    specific language governing permissions and limitations
00019  *    under the License.
00020  * ====================================================================
00021  * @endcopyright
00022  *
00023  * @file svn_user.h
00024  * @brief Subversion's wrapper around APR's user information interface.
00025  */
00026 
00027 #ifndef SVN_USER_H
00028 #define SVN_USER_H
00029 
00030 #include <apr_pools.h>
00031 
00032 #ifdef __cplusplus
00033 extern "C" {
00034 #endif /* __cplusplus */
00035 
00036 /** Get the name of the current user, using @a pool for any necessary
00037  * allocation, returning NULL on error.
00038  *
00039  * @since New in 1.4.
00040  */
00041 const char *
00042 svn_user_get_name(apr_pool_t *pool);
00043 
00044 /** Get the path of the current user's home directory, using @a pool for
00045  * any necessary allocation, returning NULL on error.
00046  *
00047  * @since New in 1.4.
00048  * @since 1.10 returns a canonical path. Earlier versions returned a
00049  * non-canonical path if the operating system reported a non-canonical
00050  * path such as "/home/user/" or "//home/user".
00051  */
00052 const char *
00053 svn_user_get_homedir(apr_pool_t *pool);
00054 
00055 #ifdef __cplusplus
00056 }
00057 #endif /* __cplusplus */
00058 
00059 #endif /* SVN_USER_H */