| LibreOffice
    LibreOffice 24.8 SDK C/C++ API Reference | 
Go to the source code of this file.
| Typedefs | |
| typedef void * | oslSecurity | 
| Process handle. | |
| Enumerations | |
| enum | oslSecurityError { osl_Security_E_None , osl_Security_E_UserUnknown , osl_Security_E_WrongPassword , osl_Security_E_Unknown , osl_Security_E_FORCE_EQUAL_SIZE = SAL_MAX_ENUM } | 
| Functions | |
| SAL_DLLPUBLIC oslSecurity | osl_getCurrentSecurity (void) | 
| Create a security handle for the current user. | |
| SAL_DLLPUBLIC oslSecurityError | osl_loginUser (rtl_uString *strUserName, rtl_uString *strPasswd, oslSecurity *pSecurity) | 
| Deprecated API Create a security handle for the denoted user. | |
| SAL_DLLPUBLIC oslSecurityError | osl_loginUserOnFileServer (rtl_uString *strUserName, rtl_uString *strPasswd, rtl_uString *strFileServer, oslSecurity *pSecurity) | 
| Create a security handle for the denoted user. | |
| SAL_DLLPUBLIC sal_Bool | osl_isAdministrator (oslSecurity Security) | 
| Query if the user who is denotes by this security has administrator rights. | |
| SAL_DLLPUBLIC void | osl_freeSecurityHandle (oslSecurity Security) | 
| Free the security handle, created by osl_loginUser or osl_getCurrentSecurity. | |
| SAL_DLLPUBLIC sal_Bool | osl_getUserIdent (oslSecurity Security, rtl_uString **strIdent) | 
| Get the login ident for the user of this security handle. | |
| SAL_DLLPUBLIC sal_Bool | osl_getUserName (oslSecurity Security, rtl_uString **strName) | 
| Get the login name for the user of this security handle. | |
| SAL_DLLPUBLIC sal_Bool | osl_getShortUserName (oslSecurity Security, rtl_uString **strName) | 
| Get the login name for the user of this security handle, excluding the domain name on Windows. | |
| SAL_DLLPUBLIC sal_Bool | osl_getHomeDir (oslSecurity Security, rtl_uString **strDirectory) | 
| Get the home directory of the user of this security handle. | |
| SAL_DLLPUBLIC sal_Bool | osl_getConfigDir (oslSecurity Security, rtl_uString **strDirectory) | 
| Get the directory for configuration data of the user of this security handle. | |
| SAL_DLLPUBLIC sal_Bool | osl_loadUserProfile (oslSecurity Security) | 
| Load Profile of the User Implemented just for Windows. | |
| SAL_DLLPUBLIC void | osl_unloadUserProfile (oslSecurity Security) | 
| Unload a User Profile Implemented just for Windows. | |
| typedef void* oslSecurity | 
Process handle.
| enum oslSecurityError | 
| SAL_DLLPUBLIC void osl_freeSecurityHandle | ( | oslSecurity | Security | ) | 
Free the security handle, created by osl_loginUser or osl_getCurrentSecurity.
| [in] | Security | the security handle. | 
| SAL_DLLPUBLIC sal_Bool osl_getConfigDir | ( | oslSecurity | Security, | 
| rtl_uString ** | strDirectory ) | 
Get the directory for configuration data of the user of this security handle.
| [in] | Security | the security handle. | 
| [out] | strDirectory | the string that receives the directory path on success. | 
| SAL_DLLPUBLIC oslSecurity osl_getCurrentSecurity | ( | void | ) | 
Create a security handle for the current user.
| SAL_DLLPUBLIC sal_Bool osl_getHomeDir | ( | oslSecurity | Security, | 
| rtl_uString ** | strDirectory ) | 
Get the home directory of the user of this security handle.
| [in] | Security | the security handle. | 
| [out] | strDirectory | the string that receives the directory path on success. | 
| SAL_DLLPUBLIC sal_Bool osl_getShortUserName | ( | oslSecurity | Security, | 
| rtl_uString ** | strName ) | 
Get the login name for the user of this security handle, excluding the domain name on Windows.
| [in] | Security | the security handle. | 
| [out] | strName | the string that receives the user name on success. | 
| SAL_DLLPUBLIC sal_Bool osl_getUserIdent | ( | oslSecurity | Security, | 
| rtl_uString ** | strIdent ) | 
Get the login ident for the user of this security handle.
| [in] | Security | the security handle. | 
| [out] | strIdent | the string that receives the ident on success. | 
| SAL_DLLPUBLIC sal_Bool osl_getUserName | ( | oslSecurity | Security, | 
| rtl_uString ** | strName ) | 
Get the login name for the user of this security handle.
| [in] | Security | the security handle. | 
| [out] | strName | the string that receives the user name on success. | 
| SAL_DLLPUBLIC sal_Bool osl_isAdministrator | ( | oslSecurity | Security | ) | 
Query if the user who is denotes by this security has administrator rights.
| [in] | Security | the security handle for th user. | 
| SAL_DLLPUBLIC sal_Bool osl_loadUserProfile | ( | oslSecurity | Security | ) | 
Load Profile of the User Implemented just for Windows.
| [in] | Security | previously fetch Security of the User | 
| SAL_DLLPUBLIC oslSecurityError osl_loginUser | ( | rtl_uString * | strUserName, | 
| rtl_uString * | strPasswd, | ||
| oslSecurity * | pSecurity ) | 
Deprecated API Create a security handle for the denoted user.
Try to log in the user on the local system.
| [in] | strUserName | denotes the name of the user to log in. | 
| [in] | strPasswd | the password for this user. | 
| [out] | pSecurity | returns the security handle if user could be logged in. | 
| SAL_DLLPUBLIC oslSecurityError osl_loginUserOnFileServer | ( | rtl_uString * | strUserName, | 
| rtl_uString * | strPasswd, | ||
| rtl_uString * | strFileServer, | ||
| oslSecurity * | pSecurity ) | 
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 mapped drive on this server.
| [in] | strUserName | denotes the name of the user to log in. | 
| [in] | strPasswd | the password for this user. | 
| [in] | strFileServer | denotes the file server on which the user is logged in. | 
| [out] | pSecurity | returns the security handle if user could be logged in. | 
| SAL_DLLPUBLIC void osl_unloadUserProfile | ( | oslSecurity | Security | ) | 
Unload a User Profile Implemented just for Windows.
| [in] | Security | previously fetch Security of the User |