Skip to content

TServiceName

Represent the name for a service.

Definition

Unit: Neslib.Iceoryx2.Types

type TServiceName = record ... end;

Properties

Name Description
Handle

Constructors

Name Description
Assign
Finalize
Initialize

Operators

Name Description
Equal
NotEqual

Methods

Name Description
AsView Creates a TServiceNameView.
Create Creates a new service name.
CreateUtf8 Creates a new service name.
ToString Returns the string containing the service name.

Property Descriptions

Handle

property Handle: THandle read GetHandle

Type: THandle


Constructor Descriptions

Assign

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

Parameters

ADest: TServiceName

ASrc: TServiceName


Finalize

destructor Finalize


Initialize

constructor Initialize


Operator Descriptions

Equal(TServiceName, Pointer)

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

Parameters

ALeft: TServiceName

ARight: Pointer

Returns

Boolean


NotEqual(TServiceName, Pointer)

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

Parameters

ALeft: TServiceName

ARight: Pointer

Returns

Boolean


Method Descriptions

AsView

Creates a TServiceNameView.

function AsView: TServiceNameView; inline

Returns

TServiceNameView


Create(String)

Creates a new service name.

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

Parameters

AName: String : The name of the service.

Returns

TResult<TServiceName, TSemanticStringError>: A Result containing the service name or an error.

Remarks

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


CreateUtf8(UTF8String)

Creates a new service name.

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

Parameters

AName: UTF8String : The name of the service.

Returns

TResult<TServiceName, TSemanticStringError>: A Result containing the service name or an error.


ToString

Returns the string containing the service name.

function ToString: String; inline

Returns

String