ObjFW
OFCreateWindowsRegistryKeyFailedException.h
1 /*
2  * Copyright (c) 2008-2024 Jonathan Schleifer <js@nil.im>
3  *
4  * All rights reserved.
5  *
6  * This program is free software: you can redistribute it and/or modify it
7  * under the terms of the GNU Lesser General Public License version 3.0 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but WITHOUT
11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
13  * version 3.0 for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * version 3.0 along with this program. If not, see
17  * <https://www.gnu.org/licenses/>.
18  */
19 
20 #import "OFException.h"
21 #import "OFWindowsRegistryKey.h"
22 
23 #include <windows.h>
24 
25 OF_ASSUME_NONNULL_BEGIN
26 
35 {
36  OFWindowsRegistryKey *_registryKey;
37  OFString *_path;
38  DWORD _options;
39  REGSAM _accessRights;
40  LPSECURITY_ATTRIBUTES _Nullable _securityAttributes;
41  LSTATUS _status;
43 }
44 
48 @property (readonly, nonatomic) OFWindowsRegistryKey *registryKey;
49 
53 @property (readonly, nonatomic) OFString *path;
54 
58 @property (readonly, nonatomic) REGSAM accessRights;
59 
63 @property OF_NULLABLE_PROPERTY (readonly, nonatomic)
64  LPSECURITY_ATTRIBUTES securityAttributes;
65 
69 @property (readonly, nonatomic) DWORD options;
70 
74 @property (readonly, nonatomic) LSTATUS status;
75 
90 + (instancetype)
91  exceptionWithRegistryKey: (OFWindowsRegistryKey *)registryKey
92  path: (OFString *)path
93  accessRights: (REGSAM)accessRights
94  securityAttributes: (nullable LPSECURITY_ATTRIBUTES)securityAttributes
95  options: (DWORD)options
96  status: (LSTATUS)status;
97 
98 - (instancetype)init OF_UNAVAILABLE;
99 
114 - (instancetype)
115  initWithRegistryKey: (OFWindowsRegistryKey *)registryKey
116  path: (OFString *)path
117  accessRights: (REGSAM)accessRights
118  securityAttributes: (nullable LPSECURITY_ATTRIBUTES)securityAttributes
119  options: (DWORD)options
120  status: (LSTATUS)status OF_DESIGNATED_INITIALIZER;
121 @end
122 
123 OF_ASSUME_NONNULL_END
An exception indicating that creating a Windows registry key failed.
Definition: OFCreateWindowsRegistryKeyFailedException.h:35
The base class for all exceptions in ObjFW.
Definition: OFException.h:155
A class for handling strings.
Definition: OFString.h:139