UDK 3.2.7 C/C++ API Reference
Public Member Functions | Protected Attributes
osl::Security Class Reference

capsulate security informations for one user. More...

#include <security_decl.hxx>

List of all members.

Public Member Functions

 Security ()
 constructor
 ~Security ()
 destructor
sal_Bool logonUser (const rtl::OUString &strName, const rtl::OUString &strPasswd)
 get the security information for one user.
sal_Bool logonUser (const rtl::OUString &strName, const rtl::OUString &strPasswd, const rtl::OUString &strFileServer)
 get the security information for one user.
sal_Bool getUserIdent (rtl::OUString &strIdent) const
 get the ident of the logged in user.
sal_Bool getUserName (rtl::OUString &strName) const
 get the name of the logged in user.
sal_Bool getHomeDir (rtl::OUString &strDirectory) const
 get the home directory of the logged in user.
sal_Bool getConfigDir (rtl::OUString &strDirectory) const
 get the directory for configuration data of the logged in user.
sal_Bool isAdministrator () const
 Query if the user who is logged inhas administrator rigths.
oslSecurity getHandle () const
 Returns the underlying oslSecurity handle.

Protected Attributes

oslSecurity m_handle

Detailed Description

capsulate security informations for one user.

A object of this class is used to execute a process with the rights an security options of a scecified user.

See also:
Process::executeProcess

Constructor & Destructor Documentation

osl::Security::Security ( ) [inline]

constructor

osl::Security::~Security ( ) [inline]

destructor


Member Function Documentation

sal_Bool osl::Security::getConfigDir ( rtl::OUString strDirectory) const [inline]

get the directory for configuration data of the logged in user.

Parameters:
[out]strDirectoryis the OUString which returns the directory name
Returns:
True, if any user is successfuly logged in, otherwise False
oslSecurity osl::Security::getHandle ( ) const [inline]

Returns the underlying oslSecurity handle.

sal_Bool osl::Security::getHomeDir ( rtl::OUString strDirectory) const [inline]

get the home directory of the logged in user.

Parameters:
[out]strDirectoryis the OUString which returns the directory name
Returns:
True, if any user is successfuly logged in, otherwise False
sal_Bool osl::Security::getUserIdent ( rtl::OUString strIdent) const [inline]

get the ident of the logged in user.

Parameters:
[out]strIdentis the OUString which returns the name
Returns:
True, if any user is successfuly logged in, otherwise False
sal_Bool osl::Security::getUserName ( rtl::OUString strName) const [inline]

get the name of the logged in user.

Parameters:
[out]strNameis the OUString which returns the name
Returns:
True, if any user is successfuly logged in, otherwise False
sal_Bool osl::Security::isAdministrator ( ) const [inline]

Query if the user who is logged inhas administrator rigths.

Returns:
True, if the user has administrator rights, otherwise false.
sal_Bool osl::Security::logonUser ( const rtl::OUString strName,
const rtl::OUString strPasswd,
const rtl::OUString strFileServer 
) [inline]

get the security information for one user.

This method will try to login the user at the denoted file server. If a network resource named \server exists and this resource could be connected by this user, the methos will return true and getHomeDir will return \server.

Parameters:
[in]strNamedenotes the name of the user
[in]strPasswddenotes the password of this user
Returns:
True, if the specified user is known by file server and the could be connected, otherwise False
sal_Bool osl::Security::logonUser ( const rtl::OUString strName,
const rtl::OUString strPasswd 
) [inline]

get the security information for one user.

The underlying operating system is asked for this information.

Parameters:
[in]strNamedenotes the name of the user
[in]strPasswddenotes the password of this user
Returns:
True, if the specified user is known by the underlying operating system, otherwise False

Member Data Documentation


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines