LibreOffice LibreOffice 6.2 SDK C/C++ API Reference

security_decl.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20 #ifndef INCLUDED_OSL_SECURITY_DECL_HXX
21 #define INCLUDED_OSL_SECURITY_DECL_HXX
22
23 #include "rtl/ustring.hxx"
24 #include "osl/security.h"
25
26 namespace osl
27 {
28
34 class Security
35 {
36 protected:
37 oslSecurity m_handle;
38
39 public:
40 inline Security();
41 inline ~Security();
42
52 inline bool SAL_CALL logonUser(const rtl::OUString& strName,
53 const rtl::OUString& strPasswd);
54
72 inline bool SAL_CALL logonUser(const rtl::OUString & strName,
73 const rtl::OUString & strPasswd,
74 const rtl::OUString & strFileServer);
75
83 inline bool SAL_CALL getUserIdent( rtl::OUString& strIdent) const;
84
94 inline bool SAL_CALL getUserName( rtl::OUString& strName, bool bIncludeDomain=true ) const;
95
102 inline bool SAL_CALL getHomeDir( rtl::OUString& strDirectory) const;
103
111 inline bool SAL_CALL getConfigDir( rtl::OUString & strDirectory) const;
112
118 inline bool SAL_CALL isAdministrator() const;
119
122 inline oslSecurity getHandle() const;
123 };
124
125 }
126
127 #endif // INCLUDED_OSL_SECURITY_DECL_HXX
128
129 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
security.h
osl::Security::~Security
~Security()
Definition: security.hxx:38
osl::Security::Security
Security()
Definition: security.hxx:33
oslSecurity
void * oslSecurity
Process handle.
Definition: security.h:45
osl::Security::getUserName
bool getUserName(rtl::OUString &strName, bool bIncludeDomain=true) const
get the name of the logged in user.
Definition: security.hxx:72
osl::Security::getHomeDir
bool getHomeDir(rtl::OUString &strDirectory) const
get the home directory of the logged in user.
Definition: security.hxx:80
ustring.hxx
osl::Security::getConfigDir
bool getConfigDir(rtl::OUString &strDirectory) const
get the directory for configuration data of the logged in user.
Definition: security.hxx:86
osl::Security
Encapsulate security information for one user.
Definition: security_decl.hxx:34
osl::Security::getUserIdent
bool getUserIdent(rtl::OUString &strIdent) const
get the ident of the logged in user.
Definition: security.hxx:66
osl::Security::isAdministrator
bool isAdministrator() const
Query if the user who is logged in has administrator rights.
Definition: security.hxx:91
osl
Definition: condition.hxx:28
osl::Security::getHandle
oslSecurity getHandle() const
Returns the underlying oslSecurity handle.
Definition: security.hxx:96
rtl::OUString
This String class provides base functionality for C++ like Unicode character array handling.
Definition: ustring.hxx:123
osl::Security::logonUser
bool logonUser(const rtl::OUString &strName, const rtl::OUString &strPasswd)
get the security information for one user.
Definition: security.hxx:43
osl::Security::m_handle
oslSecurity m_handle
Definition: security_decl.hxx:37