1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
|
.TH ACE_Registry::Naming_Context 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_Registry::Naming_Context \- An context representation.
.SH SYNOPSIS
.br
.PP
\fC#include <Registry.h>\fR
.PP
.SS Public Types
.in +1c
.ti -1c
.RI "enum { \fBMAX_OBJECT_NAME_SIZE\fR = BUFSIZ, \fBMAX_CONTEXT_NAME_SIZE\fR = MAXPATHLEN + 1 }"
.br
.in -1c
.SS Public Methods
.in +1c
.ti -1c
.RI "\fBNaming_Context\fR (void)"
.br
.RI "\fIEmpty constructor: keys will be NULL.\fR"
.ti -1c
.RI "\fBNaming_Context\fR (const HKEY &key)"
.br
.RI "\fIConstructor: key_ will be set to <key>.\fR"
.ti -1c
.RI "\fB~Naming_Context\fR (void)"
.br
.RI "\fIDestructor will call <\fBNaming_Context::close\fR>.\fR"
.ti -1c
.RI "int \fBbind_new\fR (const \fBName\fR &name, const \fBObject\fR &object)"
.br
.ti -1c
.RI "int \fBbind_new\fR (const ACE_TString &name, const \fBObject\fR &object)"
.br
.ti -1c
.RI "int \fBbind\fR (const \fBName\fR &name, const \fBObject\fR &object)"
.br
.ti -1c
.RI "int \fBbind\fR (const ACE_TString &name, const \fBObject\fR &object)"
.br
.ti -1c
.RI "int \fBrebind\fR (const \fBName\fR &name, const \fBObject\fR &object)"
.br
.RI "\fIUpdate <object> with <name> in <this> context (Name version).\fR"
.ti -1c
.RI "int \fBrebind\fR (const ACE_TString &name, const \fBObject\fR &object)"
.br
.RI "\fIUpdate <object> with <name> in <this> context.\fR"
.ti -1c
.RI "int \fBresolve\fR (const \fBName\fR &name, \fBObject\fR &object)"
.br
.RI "\fIFind <object> with <name> in <this> context (Name version).\fR"
.ti -1c
.RI "int \fBresolve\fR (const ACE_TString &name, \fBObject\fR &object)"
.br
.RI "\fIFind <object> with <name> in <this> context.\fR"
.ti -1c
.RI "int \fBunbind\fR (const \fBName\fR &name)"
.br
.RI "\fIDelete object with <name> in <this> context (Name version).\fR"
.ti -1c
.RI "int \fBunbind\fR (const ACE_TString &name)"
.br
.RI "\fIDelete object with <name> in <this> context.\fR"
.ti -1c
.RI "int \fBnew_context\fR (Naming_Context &naming_context)"
.br
.RI "\fICreate new <naming_context>.\fR"
.ti -1c
.RI "int \fBbind_new_context\fR (const \fBName\fR &name, Naming_Context &naming_context, u_long persistence = REG_OPTION_NON_VOLATILE, u_long security_access = KEY_ALL_ACCESS, LPSECURITY_ATTRIBUTES security_attributes = 0)"
.br
.ti -1c
.RI "int \fBbind_new_context\fR (const ACE_TString &name, Naming_Context &naming_context, u_long persistence = REG_OPTION_NON_VOLATILE, u_long security_access = KEY_ALL_ACCESS, LPSECURITY_ATTRIBUTES security_attributes = 0)"
.br
.RI "\fIInsert <naming_context> with <name> relative to <this> context This will fail if <name> already exists.\fR"
.ti -1c
.RI "int \fBbind_context\fR (const \fBName\fR &name, Naming_Context &naming_context, u_long persistence = REG_OPTION_NON_VOLATILE, u_long security_access = KEY_ALL_ACCESS, LPSECURITY_ATTRIBUTES security_attributes = 0)"
.br
.ti -1c
.RI "int \fBbind_context\fR (const ACE_TString &name, Naming_Context &naming_context, u_long persistence = REG_OPTION_NON_VOLATILE, u_long security_access = KEY_ALL_ACCESS, LPSECURITY_ATTRIBUTES security_attributes = 0)"
.br
.RI "\fIInsert or update <naming_context> with <name> relative to <this> context This will not fail if <name> already exists.\fR"
.ti -1c
.RI "int \fBrebind_context\fR (const \fBName\fR &name, Naming_Context &naming_context)"
.br
.RI "\fIRename <naming_context> to <name> (Name version).\fR"
.ti -1c
.RI "int \fBrebind_context\fR (const ACE_TString &name, Naming_Context &naming_context)"
.br
.RI "\fIRename <naming_context> to <name>.\fR"
.ti -1c
.RI "int \fBresolve_context\fR (const \fBName\fR &name, Naming_Context &naming_context, u_long security_access = KEY_ALL_ACCESS)"
.br
.RI "\fIFind <naming_context> with <name> in <this> context (Name version).\fR"
.ti -1c
.RI "int \fBresolve_context\fR (const ACE_TString &name, Naming_Context &naming_context, u_long security_access = KEY_ALL_ACCESS)"
.br
.RI "\fIFind <naming_context> with <name> in <this> context.\fR"
.ti -1c
.RI "int \fBunbind_context\fR (const \fBName\fR &name)"
.br
.RI "\fIRemove naming_context with <name> from <this> context (Name version).\fR"
.ti -1c
.RI "int \fBunbind_context\fR (const ACE_TString &name)"
.br
.RI "\fIRemove naming_context with <name> from <this> context.\fR"
.ti -1c
.RI "int \fBdestroy\fR (void)"
.br
.RI "\fISame as <unbind_context> with <this> as naming_context.\fR"
.ti -1c
.RI "int \fBlist\fR (u_long how_many, \fBBinding_List\fR &list, \fBBinding_Iterator\fR &iterator)"
.br
.ti -1c
.RI "int \fBlist\fR (\fBBinding_List\fR &list)"
.br
.RI "\fIlisting function: iterator creator This gives back a listing of all entries in <this> context.\fR"
.ti -1c
.RI "int \fBflush\fR (void)"
.br
.RI "\fISync content of context to disk.\fR"
.ti -1c
.RI "int \fBclose\fR (void)"
.br
.RI "\fIClose the handle of the context Note: <close> does not call <flush>.\fR"
.ti -1c
.RI "HKEY \fBkey\fR (void)"
.br
.RI "\fIGet key.\fR"
.ti -1c
.RI "HKEY \fBparent\fR (void)"
.br
.RI "\fIGet parent.\fR"
.ti -1c
.RI "void \fBname\fR (\fBName\fR &name)"
.br
.RI "\fIGet name (Name version).\fR"
.ti -1c
.RI "void \fBname\fR (ACE_TString &name)"
.br
.RI "\fIGet name (String version).\fR"
.ti -1c
.RI "ACE_TString \fBname\fR (void)"
.br
.in -1c
.SS Protected Methods
.in +1c
.ti -1c
.RI "void \fBkey\fR (HKEY key)"
.br
.RI "\fISet key.\fR"
.ti -1c
.RI "void \fBparent\fR (HKEY parent)"
.br
.RI "\fISet parent.\fR"
.ti -1c
.RI "void \fBname\fR (const \fBName\fR &name)"
.br
.RI "\fISet name (Name version).\fR"
.ti -1c
.RI "void \fBname\fR (const ACE_TString &name)"
.br
.RI "\fISet name (String version).\fR"
.in -1c
.SS Private Methods
.in +1c
.ti -1c
.RI "\fBNaming_Context\fR (const Naming_Context &rhs)"
.br
.RI "\fIDisallow copy constructors.\fR"
.ti -1c
.RI "const Naming_Context& \fBoperator=\fR (const Naming_Context &rhs)"
.br
.RI "\fIDisallow assignment.\fR"
.in -1c
.SS Private Attributes
.in +1c
.ti -1c
.RI "HKEY \fBkey_\fR"
.br
.RI "\fIKey for self.\fR"
.ti -1c
.RI "HKEY \fBparent_key_\fR"
.br
.RI "\fIKey for parent.\fR"
.ti -1c
.RI "ACE_TString \fBname_\fR"
.br
.RI "\fIName of self.\fR"
.in -1c
.SS Friends
.in +1c
.ti -1c
.RI "class \fBACE_Predefined_Naming_Contexts\fR"
.br
.in -1c
.SH DETAILED DESCRIPTION
.PP
An context representation.
.PP
.PP
Think about a context as being similar to a directory in a file system.
.PP
.SH MEMBER ENUMERATION DOCUMENTATION
.PP
.SS anonymous enum
.PP
\fBEnumeration values:\fR
.in +1c
.TP
\fB\fIMAX_OBJECT_NAME_SIZE\fR \fRMax sizes of names (Not too sure about this value).
.TP
\fB\fIMAX_CONTEXT_NAME_SIZE\fR \fRMax size of context name.
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP
.SS ACE_Registry::Naming_Context::Naming_Context (void)
.PP
Empty constructor: keys will be NULL.
.PP
.SS ACE_Registry::Naming_Context::Naming_Context (const HKEY & key)
.PP
Constructor: key_ will be set to <key>.
.PP
.SS ACE_Registry::Naming_Context::~Naming_Context (void)
.PP
Destructor will call <\fBNaming_Context::close\fR>.
.PP
.SS ACE_Registry::Naming_Context::Naming_Context (const Naming_Context & rhs)\fC [private]\fR
.PP
Disallow copy constructors.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP
.SS int ACE_Registry::Naming_Context::bind (const ACE_TString & name, const \fBObject\fR & object)
.PP
Insert or update <object> with <name> into <this> context This will not fail if <name> already exists (String version)
.SS int ACE_Registry::Naming_Context::bind (const \fBName\fR & name, const \fBObject\fR & object)
.PP
Insert or update <object> with <name> into <this> context This will not fail if <name> already exists (Name version)
.SS int ACE_Registry::Naming_Context::bind_context (const ACE_TString & name, Naming_Context & naming_context, u_long persistence = REG_OPTION_NON_VOLATILE, u_long security_access = KEY_ALL_ACCESS, LPSECURITY_ATTRIBUTES security_attributes = 0)
.PP
Insert or update <naming_context> with <name> relative to <this> context This will not fail if <name> already exists.
.PP
.SS int ACE_Registry::Naming_Context::bind_context (const \fBName\fR & name, Naming_Context & naming_context, u_long persistence = REG_OPTION_NON_VOLATILE, u_long security_access = KEY_ALL_ACCESS, LPSECURITY_ATTRIBUTES security_attributes = 0)
.PP
Insert or update <naming_context> with <name> relative to <this> context This will not fail if <name> already exists (Name version)
.SS int ACE_Registry::Naming_Context::bind_new (const ACE_TString & name, const \fBObject\fR & object)
.PP
Insert <object> with <name> into <this> context This will fail if <name> already exists (String version)
.SS int ACE_Registry::Naming_Context::bind_new (const \fBName\fR & name, const \fBObject\fR & object)
.PP
Insert <object> with <name> into <this> context This will fail if <name> already exists (Name version)
.SS int ACE_Registry::Naming_Context::bind_new_context (const ACE_TString & name, Naming_Context & naming_context, u_long persistence = REG_OPTION_NON_VOLATILE, u_long security_access = KEY_ALL_ACCESS, LPSECURITY_ATTRIBUTES security_attributes = 0)
.PP
Insert <naming_context> with <name> relative to <this> context This will fail if <name> already exists.
.PP
.SS int ACE_Registry::Naming_Context::bind_new_context (const \fBName\fR & name, Naming_Context & naming_context, u_long persistence = REG_OPTION_NON_VOLATILE, u_long security_access = KEY_ALL_ACCESS, LPSECURITY_ATTRIBUTES security_attributes = 0)
.PP
Insert <naming_context> with <name> relative to <this> context This will fail if <name> already exists (Name version)
.SS int ACE_Registry::Naming_Context::close (void)
.PP
Close the handle of the context Note: <close> does not call <flush>.
.PP
.SS int ACE_Registry::Naming_Context::destroy (void)
.PP
Same as <unbind_context> with <this> as naming_context.
.PP
.SS int ACE_Registry::Naming_Context::flush (void)
.PP
Sync content of context to disk.
.PP
.SS void ACE_Registry::Naming_Context::key (HKEY key)\fC [protected]\fR
.PP
Set key.
.PP
.SS HKEY ACE_Registry::Naming_Context::key (void)
.PP
Get key.
.PP
.SS int ACE_Registry::Naming_Context::list (\fBBinding_List\fR & list)
.PP
listing function: iterator creator This gives back a listing of all entries in <this> context.
.PP
.SS int ACE_Registry::Naming_Context::list (u_long how_many, \fBBinding_List\fR & list, \fBBinding_Iterator\fR & iterator)
.PP
listing function: iterator creator This is useful when there are many objects and contexts in <this> context and you only want to look at a few entries at a time
.SS void ACE_Registry::Naming_Context::name (const ACE_TString & name)\fC [protected]\fR
.PP
Set name (String version).
.PP
.SS void ACE_Registry::Naming_Context::name (const \fBName\fR & name)\fC [protected]\fR
.PP
Set name (Name version).
.PP
.SS ACE_TString ACE_Registry::Naming_Context::name (void)
.PP
.SS void ACE_Registry::Naming_Context::name (ACE_TString & name)
.PP
Get name (String version).
.PP
.SS void ACE_Registry::Naming_Context::name (\fBName\fR & name)
.PP
Get name (Name version).
.PP
.SS int ACE_Registry::Naming_Context::new_context (Naming_Context & naming_context)
.PP
Create new <naming_context>.
.PP
.SS const Naming_Context & ACE_Registry::Naming_Context::operator= (const Naming_Context & rhs)\fC [private]\fR
.PP
Disallow assignment.
.PP
.SS void ACE_Registry::Naming_Context::parent (HKEY parent)\fC [protected]\fR
.PP
Set parent.
.PP
.SS HKEY ACE_Registry::Naming_Context::parent (void)
.PP
Get parent.
.PP
.SS int ACE_Registry::Naming_Context::rebind (const ACE_TString & name, const \fBObject\fR & object)
.PP
Update <object> with <name> in <this> context.
.PP
.SS int ACE_Registry::Naming_Context::rebind (const \fBName\fR & name, const \fBObject\fR & object)
.PP
Update <object> with <name> in <this> context (Name version).
.PP
.SS int ACE_Registry::Naming_Context::rebind_context (const ACE_TString & name, Naming_Context & naming_context)
.PP
Rename <naming_context> to <name>.
.PP
.SS int ACE_Registry::Naming_Context::rebind_context (const \fBName\fR & name, Naming_Context & naming_context)
.PP
Rename <naming_context> to <name> (Name version).
.PP
.SS int ACE_Registry::Naming_Context::resolve (const ACE_TString & name, \fBObject\fR & object)
.PP
Find <object> with <name> in <this> context.
.PP
.SS int ACE_Registry::Naming_Context::resolve (const \fBName\fR & name, \fBObject\fR & object)
.PP
Find <object> with <name> in <this> context (Name version).
.PP
.SS int ACE_Registry::Naming_Context::resolve_context (const ACE_TString & name, Naming_Context & naming_context, u_long security_access = KEY_ALL_ACCESS)
.PP
Find <naming_context> with <name> in <this> context.
.PP
.SS int ACE_Registry::Naming_Context::resolve_context (const \fBName\fR & name, Naming_Context & naming_context, u_long security_access = KEY_ALL_ACCESS)
.PP
Find <naming_context> with <name> in <this> context (Name version).
.PP
.SS int ACE_Registry::Naming_Context::unbind (const ACE_TString & name)
.PP
Delete object with <name> in <this> context.
.PP
.SS int ACE_Registry::Naming_Context::unbind (const \fBName\fR & name)
.PP
Delete object with <name> in <this> context (Name version).
.PP
.SS int ACE_Registry::Naming_Context::unbind_context (const ACE_TString & name)
.PP
Remove naming_context with <name> from <this> context.
.PP
.SS int ACE_Registry::Naming_Context::unbind_context (const \fBName\fR & name)
.PP
Remove naming_context with <name> from <this> context (Name version).
.PP
.SH FRIENDS AND RELATED FUNCTION DOCUMENTATION
.PP
.SS class ACE_Predefined_Naming_Contexts\fC [friend]\fR
.PP
Friend factory.
.PP
.SH MEMBER DATA DOCUMENTATION
.PP
.SS HKEY ACE_Registry::Naming_Context::key_\fC [private]\fR
.PP
Key for self.
.PP
.SS ACE_TString ACE_Registry::Naming_Context::name_\fC [private]\fR
.PP
Name of self.
.PP
.SS HKEY ACE_Registry::Naming_Context::parent_key_\fC [private]\fR
.PP
Key for parent.
.PP
.SH AUTHOR
.PP
Generated automatically by Doxygen for ACE from the source code.
|