Methods of Class Security

Class

Index

Help

Methods of Class Security

Security

Security();

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

constructor

~Security

~Security();

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

destructor

logonUser

sal_Bool logonUser(

const ::rtl::OUString &	strName,
const ::rtl::OUString &	strPasswd );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

get the security information for one user. 
The underlying operating system is asked for this information.

Parameters

strName	denotes the name of the user
strPasswd	denotes the password of this user

Return

True, if the specified user is known by the underlying operating system,
otherwise False

logonUser

sal_Bool logonUser(

const ::rtl::OUString &	strName,
const ::rtl::OUString &	strPasswd,
const ::rtl::OUString &	strFileServer );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Description

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\username exists and this resource
could be connected by this user, the methos will return true and getHomeDir
will return \\server\username.

Parameters

strName	denotes the name of the user
strPasswd	denotes the password of this user

Return

True, if the specified user is known by file server and the 
could be connected,    otherwise False

getUserIdent

sal_Bool getUserIdent(

::rtl::OUString &

strIdent ) const;

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	YES	NO	NO	NO	YES	NO

Summary

get the ident of the logged in user.

Parameters

strName	is the buffer which returns the name
max	is the size of this buffer

Return

True, if any user is successfuly logged in, otherwise False

getUserName

sal_Bool getUserName(

::rtl::OUString &

strName ) const;

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	YES	NO	NO	NO	YES	NO

Summary

get the name of the logged in user.

Parameters

strName	is the buffer which returns the name
max	is the size of this buffer

Return

True, if any user is successfuly logged in, otherwise False

getHomeDir

sal_Bool getHomeDir(

::rtl::OUString &

strDirectory ) const;

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	YES	NO	NO	NO	YES	NO

Summary

get the home directory of the logged in user.

Parameters

strDirectory	is the buffer which returns the directory name
max	is the size of this buffer

Return

True, if any user is successfuly logged in, otherwise False

getConfigDir

sal_Bool getConfigDir(

::rtl::OUString &

strDirectory ) const;

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	YES	NO	NO	NO	YES	NO

Summary

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

Parameters

strDirectory	is the buffer which returns the directory name
max	is the size of this buffer

Return

True, if any user is successfuly logged in, otherwise False

isAdministrator

sal_Bool isAdministrator();

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

Query if the user who is logged inhas administrator rigths.

Return

True, if the user has administrator rights, otherwise false.

getHandle

oslSecurity getHandle();

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

Returns the underlying oslSecurity handle

Top of Page