Erlang -- cosProperty

User's Guide
Reference Manual
Release Notes
PDF
Top

cosProperty
Reference Manual
Version 1.1.13

Expand All
Contract All

Table of Contents

- cosProperty
  - Top of manual page
  - install/0
  - install_db/0
  - uninstall/0
  - uninstall_db/0
  - start/0
  - start_SetDefFactory/0
  - start_SetFactory/0
  - stop_SetDefFactory/1
  - stop_SetFactory/1
  - stop/0
- CosPropertyService_PropertySetFactory
  - Top of manual page
  - create_propertyset/1
  - create_constrained_propertyset/3
  - create_initial_propertyset/2
- CosPropertyService_PropertySetDefFactory
  - Top of manual page
  - create_propertysetdef/1
  - create_constrained_propertysetdef/3
  - create_initial_propertysetdef/2
- CosPropertyService_PropertySet
  - Top of manual page
  - define_property/3
  - define_properties/2
  - get_number_of_properties/1
  - get_all_property_names/2
  - get_property_value/2
  - get_properties/2
  - get_all_properties/2
  - delete_property/2
  - delete_properties/2
  - delete_all_properties/1
  - is_property_defined/2
- CosPropertyService_PropertySetDef
  - Top of manual page
  - get_allowed_property_types/1
  - get_allowed_properties/1
  - define_property_with_mode/4
  - define_properties_with_modes/2
  - get_property_mode/2
  - get_property_modes/2
  - set_property_mode/3
  - set_property_modes/2
- CosPropertyService_PropertiesIterator
  - Top of manual page
  - reset/1
  - next_one/1
  - next_n/2
  - destroy/1
- CosPropertyService_PropertyNamesIterator
  - Top of manual page
  - reset/1
  - next_one/1
  - next_n/2
  - destroy/1

# cosProperty

### MODULE

cosProperty

### MODULE SUMMARY

The main module of the cosProperty application

### DESCRIPTION

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

This module contains the functions for starting and stopping the application.

### EXPORTS

install() -> Return

Types:

Return = ok | {'EXIT', Reason}

This operation installs the cosProperty application in the IFR.

install_db() -> Return

Types:

Return = ok | {'EXIT', Reason}

This operation installs data in mnesia necessary for running the cosProperty application.

uninstall() -> Return

Types:

Return = ok | {'EXIT', Reason}

This operation removes all data in the IFR related to the cosProperty application.

uninstall_db() -> Return

Types:

Return = ok | {'EXIT', Reason}

This operation removes all data from mnesia related to the cosProperty application.

start() -> Return

Types:

Return = ok | {error, Reason}

This operation starts the cosProperty application.

start_SetDefFactory() -> Return

Types:

Return = Factory | {'EXCEPTION', E}
Factory = CosPropertyService::PropertySetDefFactory reference.

This operation starts a PropertySetDef Factory.

start_SetFactory() -> Return

Types:

Return = Factory | {'EXCEPTION', E}
Factory = CosPropertyService::PropertySetDefFactory reference.

This operation starts a PropertySet Factory.

stop_SetDefFactory(Factory) -> Return

Types:

Factory = CosPropertyService::PropertySetDefFactory reference.
Return = ok | {'EXCEPTION', E}

This operation stops the supplied PropertySetDef Factory.

stop_SetFactory(Factory) -> Return

Types:

Factory = CosPropertyService::PropertySetFactory reference.
Return = ok | {'EXCEPTION', E}

This operation stops the supplied PropertySet Factory.

stop() -> Return

Types:

Return = ok | {error, Reason}

This operation stops the cosProperty application.