LibreOffice: osl/security_decl.hxx Source File

LibreOffice LibreOffice 7.3 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/*
21 * This file is part of LibreOffice published API.
22 */
23
24#ifndef INCLUDED_OSL_SECURITY_DECL_HXX
25#define INCLUDED_OSL_SECURITY_DECL_HXX
26
27#include "rtl/ustring.hxx"
28#include "osl/security.h"
29
30namespace osl
31{
32
38 class Security
39{
40protected:
41 oslSecurity m_handle;
42
43public:
44 inline Security();
45 inline ~Security();
46
56 inline bool SAL_CALL logonUser(const rtl::OUString& strName,
57 const rtl::OUString& strPasswd);
58
76 inline bool SAL_CALL logonUser(const rtl::OUString & strName,
77 const rtl::OUString & strPasswd,
78 const rtl::OUString & strFileServer);
79
87 inline bool SAL_CALL getUserIdent( rtl::OUString& strIdent) const;
88
98 inline bool SAL_CALL getUserName( rtl::OUString& strName, bool bIncludeDomain=true ) const;
99
106 inline bool SAL_CALL getHomeDir( rtl::OUString& strDirectory) const;
107
115 inline bool SAL_CALL getConfigDir( rtl::OUString & strDirectory) const;
116
122 inline bool SAL_CALL isAdministrator() const;
123
126 inline oslSecurity getHandle() const;
127};
128
129}
130
131#endif // INCLUDED_OSL_SECURITY_DECL_HXX
132
133/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
ustring.hxx
security.h
oslSecurity
void * oslSecurity
Process handle.
Definition: security.h:49
osl
Definition: condition.hxx:31
rtl::OUString
This String class provides base functionality for C++ like Unicode character array handling.
Definition: ustring.hxx:204
osl::Security
Encapsulate security information for one user.
Definition: security_decl.hxx:39
osl::Security::Security
Security()
Definition: security.hxx:37
osl::Security::getUserIdent
bool getUserIdent(rtl::OUString &strIdent) const
get the ident of the logged in user.
Definition: security.hxx:70
osl::Security::isAdministrator
bool isAdministrator() const
Query if the user who is logged in has administrator rights.
Definition: security.hxx:95
osl::Security::~Security
~Security()
Definition: security.hxx:42
osl::Security::m_handle
oslSecurity m_handle
Definition: security_decl.hxx:41
osl::Security::getConfigDir
bool getConfigDir(rtl::OUString &strDirectory) const
get the directory for configuration data of the logged in user.
Definition: security.hxx:90
osl::Security::getHomeDir
bool getHomeDir(rtl::OUString &strDirectory) const
get the home directory of the logged in user.
Definition: security.hxx:84
osl::Security::getHandle
oslSecurity getHandle() const
Returns the underlying oslSecurity handle.
Definition: security.hxx:100
osl::Security::getUserName
bool getUserName(rtl::OUString &strName, bool bIncludeDomain=true) const
get the name of the logged in user.
Definition: security.hxx:76
osl::Security::logonUser
bool logonUser(const rtl::OUString &strName, const rtl::OUString &strPasswd)
get the security information for one user.
Definition: security.hxx:47