From 84adefa331c4159d432d22840663c38f155cd4c1 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Fri, 20 Nov 2009 14:54:40 +0000 Subject: The R13B03 release. --- lib/orber/doc/src/lname.xml | 165 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 165 insertions(+) create mode 100644 lib/orber/doc/src/lname.xml (limited to 'lib/orber/doc/src/lname.xml') diff --git a/lib/orber/doc/src/lname.xml b/lib/orber/doc/src/lname.xml new file mode 100644 index 0000000000..7776e1298c --- /dev/null +++ b/lib/orber/doc/src/lname.xml @@ -0,0 +1,165 @@ + + + + +
+ + 19972009 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + lname + + + + + + 1997-06-10 + A +
+ lname + Interface that supports the name pseudo-objects. + +

This interface is a part of the names library which is used to hide the + representation of names. In Orbers Erlang mapping the pseudo-object names + and the real IDL names have the same representation but it is desirable that + the clients uses the names library so they will not be dependent of the representation. + The lname interface supports handling of names e.g. adding and removing name + components.

+

Note that the lname interface in orber does not contain a destroy function because + the Names are represented as standard Erlang lists and therefor will be removed + by the garbage collector when not in use.

+

The type NameComponent used below is defined as:

+ + -record('CosNaming_NameComponent', {id, kind=""}). + +

id and kind are strings.

+

The record is defined in the file CosNaming.hrl and it + is included with:

+ + -include_lib("orber/COSS/CosNaming/CosNaming.hrl"). + + + + + create() -> Return + Create a new name + + Return = [NameComponent] + + +

This function returns a new name.

+ + + + insert_component(Name, N, NameComponent) -> Return + Insert a new name component in a name + + Name = [NameComponent] + N = int() + Return = Name + + +

This function returns a name where the new name component has been inserted as + component N in Name.

+ + + + get_component(Name, N) -> Return + Get a name component from a name + + Name = [NameComponent] + N = int() + Return = NameComponent + + +

This function returns the N:th name component in Name.

+ + + + delete_component(Name, N) -> Return + Delete a name component from a name + + Name = [NameComponent] + N = int() + Return = Name + + +

This function deletes the N:th name component from Name and returns + the new name.

+ + + + num_component(Name) -> Return + Count the number of name components in a name + + Name = [NameComponent] + Return = int() + + +

This function returns a the number of name components in Name.

+ + + + equal(Name1, Name2) -> Return + Test if two names are equal + + Name1 = Name2 = [NameComponent] + Return = bool() + + +

This function returns true if the two names are equal and false otherwise.

+ + + + less_than(Name1, Name2) -> Return + Test if one name is lesser than the other + + Name1 = Name2 = [NameComponent] + Return = bool() + + +

This function returns true if Name1 are lesser than Name2 and false otherwise.

+ + + + to_idl_form(Name) -> Return + Transform a pseudo name to an IDL name + + Name = [NameComponent] + Return = Name + + +

This function just checks if Name is a correct IDL name before returning it + because the name representation is the same for pseudo and IDL names in orber.

+ + + + from_idl_form(Name) -> Return + Transform an IDL name to a pseudo name + + Name = [NameComponent] + Return = Name + + +

This function just returns the Name because the name representation is the + same for pseudo and IDL names in orber.

+ + + + + + -- cgit v1.2.3