👤
Home Man
Search
Today's Posts
Register

Linux & Unix Commands - Search Man Pages
Man Page or Keyword Search:
Select Section of Man Page:
Select Man Page Repository:

Linux 2.6 - man page for cospropertyservice_propertyset (linux section 3erl)

CosPropertyService_PropertySet(3erl) Erlang Module DefinitionCosPropertyService_PropertySet(3erl)

NAME
       CosPropertyService_PropertySet  - This module implements the OMG CosPropertyService::Prop-
       ertySet 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',  #CosPropertySer-
		     vice_UnsupportedProperty{}}   |   {'EXCEPTION',  #CosPropertyService_ReadOn-
		     lyProperty{}}

	      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, prop-
		     erty_value = Value}]
		     Name = string()
		     Value = #any
		     Reply = ok | {'EXCEPTION', #CosPropertyService_MultipleExceptions{exceptions
		     = Excs}}
		     Excs   =	[#'CosPropertyService_PropertyException{reason	=  Reason,  fail-
		     ing_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  addi-
	      tional  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,  prop-
		     erty_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, prop-
		     erty_value = Value}]

	      This operation return a list Max properties or less. If more properties are associ-
	      ated  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{}}  |  {'EXCEP-
		     TION', #CosPropertyService_PropertyNotFound{}} | {'EXCEPTION', #CosProperty-
		     Service_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,   fail-
		     ing_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.

Ericsson AB				cosProperty 1.1.13   CosPropertyService_PropertySet(3erl)


All times are GMT -4. The time now is 02:26 AM.

Unix & Linux Forums Content Copyrightę1993-2018. All Rights Reserved.
×
UNIX.COM Login
Username:
Password:  
Show Password





Not a Forum Member?
Forgot Password?