Skip to content

TNodeName

Represent the name for a TNode.

Definition

Unit: Neslib.Iceoryx2.Types

type TNodeName = record ... end;

Properties

Name Description
Handle

Constructors

Name Description
Assign
Finalize
Initialize

Operators

Name Description
Equal
NotEqual

Methods

Name Description
AsView Creates a TNodeNameView.
Create(String) Creates a new node name.
Create(PUTF8Char, Integer)
CreateUtf8 Creates a new node name.
ToString Returns the string containing the node name.

Property Descriptions

Handle

property Handle: THandle read GetHandle

Type: THandle


Constructor Descriptions

Assign

constructor Assign(var ADest: TNodeName; const ASrc: TNodeName)

Parameters

ADest: TNodeName

ASrc: TNodeName


Finalize

destructor Finalize


Initialize

constructor Initialize


Operator Descriptions

Equal(TNodeName, Pointer)

class operator Equal(const ALeft: TNodeName; const ARight: Pointer): Boolean; inline; static

Parameters

ALeft: TNodeName

ARight: Pointer

Returns

Boolean


NotEqual(TNodeName, Pointer)

class operator NotEqual(const ALeft: TNodeName; const ARight: Pointer): Boolean; inline; static

Parameters

ALeft: TNodeName

ARight: Pointer

Returns

Boolean


Method Descriptions

AsView

Creates a TNodeNameView.

function AsView: TNodeNameView; inline

Returns

TNodeNameView


Create(String)

Creates a new node name.

class function Create(const AName: String): TResult<TNodeName, TSemanticStringError>; overload; inline; static

Parameters

AName: String : The name of the node.

Returns

TResult<TNodeName, TSemanticStringError>: A Result containing the node name or an error.

Remarks

Use CreateUtf8 for a more efficient version that bypasses UTF-8 conversion.


Create(PUTF8Char, Integer)

class function Create(const AName: PUTF8Char; const ALength: Integer): TResult<TNodeName, TSemanticStringError>; overload; static

Parameters

AName: PUTF8Char

ALength: Integer

Returns

TResult<TNodeName, TSemanticStringError>


CreateUtf8(UTF8String)

Creates a new node name.

class function CreateUtf8(const AName: UTF8String): TResult<TNodeName, TSemanticStringError>; inline; static

Parameters

AName: UTF8String : The name of the node.

Returns

TResult<TNodeName, TSemanticStringError>: A Result containing the node name or an error.


ToString

Returns the string containing the node name.

function ToString: String; inline

Returns

String