The Free and Open Productivity Suite
Follow us on Twitter: @ApacheOO

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


Global Functions in Global Namespace C++
in Sourcefile security.h


osl_freeSecurityHandle
extern "C"
void osl_freeSecurityHandle(
oslSecurity Security );

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

Summary
Free the security handle, created by osl_loginUser or osl_getCurrentSecurity.
Parameters
Security
the security handle.
See Also
osl_loginUser

osl_getConfigDir
extern "C"
sal_Bool osl_getConfigDir(
oslSecurity Security,
rtl_uString * * strDirectory );

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

Summary
Get the directory for configuration data of the user of this security handle.
Parameters
Security
the security handle.
strDirectory
the string that receives the directory path on success.
Return
True, if the security handle is valid, otherwise False.

osl_getCurrentSecurity
extern "C"
oslSecurity osl_getCurrentSecurity(
void );

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

Summary
Create a security handle for the current user.
Return
a security handle or NULL on failure.
See Also
osl_freeSecurityHandle
osl_executeProcess
osl_executeApplication

osl_getHomeDir
extern "C"
sal_Bool osl_getHomeDir(
oslSecurity Security,
rtl_uString * * strDirectory );

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

Summary
Get the home directory of the user of this security handle.
Parameters
Security
the security handle.
strDirectory
the string that receives the directory path on success.
Return
True, if the security handle is valid, otherwise False.

osl_getUserIdent
extern "C"
sal_Bool osl_getUserIdent(
oslSecurity Security,
rtl_uString * * strIdent );

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

Summary
Get the login ident for the user of this security handle.
Parameters
Security
the security handle.
strIdent
the string that receives the ident on success.
Return
True, if the security handle is valid, otherwise False.

osl_getUserName
extern "C"
sal_Bool osl_getUserName(
oslSecurity Security,
rtl_uString * * strName );

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

Summary
Get the login name for the user of this security handle.
Parameters
Security
the security handle.
pszName
the string that receives the user name on success.
Return
True, if the security handle is valid, otherwise False.

osl_isAdministrator
extern "C"
sal_Bool osl_isAdministrator(
oslSecurity Security );

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

Summary
Query if the user who is denotes by this security has administrator rigths.
Parameters
Security
the security handle for th user.
Return
True, if the user has adminsitrator rights, otherwise false.

osl_loadUserProfile
extern "C"
sal_Bool osl_loadUserProfile(
oslSecurity Security );

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

Summary
Load Profile of the User Implemented just for Windows
Parameters
oslSecurity
Security [in] previously fetch Security of the User
Return
True if the Profile could successfully loaded, False otherwise.

osl_loginUser
extern "C"
oslSecurityError osl_loginUser(
rtl_uString * strUserName,
rtl_uString * strPasswd,
oslSecurity * pSecurity );

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

Summary
Create a security handle for the denoted user. Try to log in the user on the local system.
Parameters
strzUserName
denotes the name of the user to logg in.
strPasswd
the password for this user.
pSecurity
returns the security handle if user could be logged in.
Return
osl_Security_E_None if user could be logged in, otherwise an error-code.
See Also
osl_freeSecurityHandle
osl_executeProcess
osl_executeApplication

osl_loginUserOnFileServer
extern "C"
oslSecurityError osl_loginUserOnFileServer(
rtl_uString * strUserName,
rtl_uString * strPasswd,
rtl_uString * strFileServer,
oslSecurity * pSecurity );

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

Description
Create a security handle for the denoted user. Try to log in the user on the denoted file server. On success the homedir will be the maped drive on this server.
Parameters
strUserName
denotes the name of the user to logg in.
strPasswd
the password for this user.
strFileServer
denotes the file server on wich the user is logged in.
pSecurity
returns the security handle if user could be logged in.
Return
osl_Security_E_None if user could be logged in, otherwise an error-code.
See Also
osl_freeSecurityHandle
osl_executeProcess
osl_executeApplication

osl_unloadUserProfile
extern "C"
void osl_unloadUserProfile(
oslSecurity Security );

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

Summary
Unload a User Profile Implemented just for Windows
Parameters
oslSecurity
Security [in] previously fetch Security of the User
Return
nothing is returned!

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.