Overview

Module

Use

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

---

:: com :: sun :: star :: container ::

interface XNameAccess

Base Interfaces XNameAccess ┗ XElementAccess XElementAccess (referenced interface's summary:) This is the base interface of all collection interfaces.

Description is used to access named objects within a container. To implement inaccurate name access, support the ::com::sun::star::beans::XExactName interface. See also ::com::sun::star::beans::XExactName Developers Guide ProUNO - Collections and Containers

---

Methods' Summary
getByName
getElementNames
hasByName

Methods' Details

getByName any getByName( [in] string  aName ) raises( NoSuchElementException, ::com::sun::star::lang::WrappedTargetException ); Returns the object with the specified name. Parameter aName the name of the object. Throws NoSuchElementException if an element under Name does not exist. Throws com::sun::star::lang::WrappedTargetException If the implementation has internal reasons for exceptions, then wrap these in a ::com::sun::star::lang::WrappedTargetException exception.

getElementNames sequence< string > getElementNames(); Returns a sequence of all element names in this container. The order of the names is not specified.

hasByName boolean hasByName( [in] string  aName ); Returns true if an element with this name is in the container, false otherwise. In many cases the next call is XNameAccess::getByName. You should optimize this case. Parameter aName the name of the object.

Top of Page

---

Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.