---
name: "CosPropertyService_PropertySet"
section: "3erl"
platform: "linux"
package: "erlang-manpages"
version: "1:19.2.1+dfsg-2+deb9u3"
release: "Debian 9 (Stretch)"
platforms: ["linux"]
url: "https://new.carta.tech/CosPropertyService_PropertySet"
---

# CosPropertyService\_PropertySet(3erl)

This module implements the OMG CosPropertyService::PropertySet interface.

## NAME

CosPropertyService\_PropertySet - This module implements the OMG CosPropertyService::PropertySet interface.

## DESCRIPTION

To get access to the record definitions for the structures use: \
 *-include\_lib("cosProperty/include/CosPropertyService.hrl").*

## EXPORTS

**define\_property(PropertySet, Name, Value) -\> Reply**\

Types:

PropertySet = #objref\
 Name = non-empty string()\
 Value = #any\
 Reply = ok \| {'EXCEPTION', #CosPropertyService\_InvalidPropertyName{}} \| {'EXCEPTION', #CosPropertyService\_ConflictingProperty{}} \| {'EXCEPTION', #CosPropertyService\_UnsupportedTypeCode{}} \| {'EXCEPTION', #CosPropertyService\_UnsupportedProperty{}} \| {'EXCEPTION', #CosPropertyService\_ReadOnlyProperty{}}\

This operation adds a new property to the given object. Depending on which initial arguments was supplied when starting the object several exceptions may be raised.

**define\_properties(PropertySet, Properties) -\> Reply**\

Types:

PropertySet = #objref\
 Properties = \[#'CosPropertyService\_Property'{property\_name = Name, property\_value = Value}\]\
 Name = string()\
 Value = #any\
 Reply = ok \| {'EXCEPTION', #CosPropertyService\_MultipleExceptions{exceptions = Excs}}\
 Excs = \[#'CosPropertyService\_PropertyException{reason = Reason, failing\_property\_name = Name}\]\
 Reason = invalid\_property\_name \| conflicting\_property \| property\_not\_found \| unsupported\_type\_code \| unsupported\_property \| unsupported\_mode \| fixed\_property \| read\_only\_property\

This operation adds several new properties to the given object. Depending on which initial arguments was supplied when starting the object an exceptions may be raised listing the properties failing.

**get\_number\_of\_properties(PropertySet) -\> ulong()**\

Types:

PropertySet = #objref\

This operation returns the number of properties associated with the target object.

**get\_all\_property\_names(PropertySet, Max) -\> Reply**\

Types:

PropertySet = NamesIterator = #objref\
 Max = ulong()\
 Reply = {ok, Names, NamesIterator}\
 Names = \[string()\]\

This operation returns up to *Max* property names. If the target object have additional associated properties they will be put in the returned Iterator, otherwise the Iterator will be a *NIL* object.

**get\_property\_value(PropertySet, Name) -\> Reply**\

Types:

PropertySet = #objref\
 Name = string()\
 Reply = #any \| {'EXCEPTION', #CosPropertyService\_PropertyNotFound{}} \| {'EXCEPTION', #CosPropertyService\_InvalidPropertyName{}}\

This operation returns the property value associated with given name. If no such property exists or the given name is an empty string an exception will be raised.

**get\_properties(PropertySet, Names) -\> Reply**\

Types:

PropertySet = #objref\
 Names = \[string()\]\
 Reply = {boolean(), Properties}\
 Properties = \[#'CosPropertyService\_Property'{property\_name = Name, property\_value = Value}\]\

This operation returns all properties associated with given names. If the boolean flag is true all properties where retrieved correctly, otherwise, all properties with the type *tk\_void* was not found.

**get\_all\_properties(PropertySet, Max) -\> Reply**\

Types:

PropertySet = PropertiesIterator = #objref\
 Reply = {ok, Properties, PropertiesIterator}\
 Properties = \[#'CosPropertyService\_Property'{property\_name = Name, property\_value = Value}\]\

This operation return a list *Max* properties or less. If more properties are associated with the target object they will be put in the *PropertiesIterator*. If the object had less than *Max* associated properties the Iterator will be a *NIL* object.

**delete\_property(PropertySet, Name) -\> Reply**\

Types:

PropertySet = #objref\
 Name = string()\
 Reply = ok \| {'EXCEPTION', #CosPropertyService\_FixedProperty{}} \| {'EXCEPTION', #CosPropertyService\_PropertyNotFound{}} \| {'EXCEPTION', #CosPropertyService\_InvalidPropertyName{}}\

This operation tries to delete the property with given Name. An exception which indicates why it failed is raised if so needed.

**delete\_properties(PropertySet, Names) -\> Reply**\

Types:

PropertySet = #objref\
 Names = \[string()\]\
 Reply = ok \| {'EXCEPTION', #CosPropertyService\_MultipleExceptions{exceptions = Excs}}\
 Excs = \[#'CosPropertyService\_PropertyException{reason = Reason, failing\_property\_name = Name}\]\
 Reason = invalid\_property\_name \| conflicting\_property \| property\_not\_found \| unsupported\_type\_code \| unsupported\_property \| unsupported\_mode \| fixed\_property \| read\_only\_property\

This operation tries to delete all given Properties. If one or more removal fails an exception is raised which describe why.

**delete\_all\_properties(PropertySet) -\> boolean()**\

Types:

PropertySet = #objref\

This operation deletes all properties. The boolean flag, if set to false, indicates that it was not possible to remove one or more properties, e.g., may be read only.

**is\_property\_defined(PropertySet, Name) -\> Reply**\

Types:

PropertySet = #objref\
 Name = non-empty string()\
 Reply = boolean() \| {'EXCEPTION', #CosPropertyService\_InvalidPropertyName{}}\

This operation returns true if the target have an associated property with given name.