Skip to content

TAttributeSpecifier

Represents the set of attributes that are defined when the service is created.

Definition

Unit: Neslib.Iceoryx2.Types

type TAttributeSpecifier = record ... end;

Properties

Name Description
Handle

Constructors

Name Description
Assign
Finalize
Initialize

Operators

Name Description
Equal
NotEqual

Methods

Name Description
Attributes Returns the underlying TAttributeSetView
Define Defines a value for a specific key. A key is allowed to have multiple values.
DefineUtf8 Defines a value for a specific key. A key is allowed to have multiple values.
New Creates a new TAttributeSpecifier.

Property Descriptions

Handle

property Handle: THandle read GetHandle

Type: THandle


Constructor Descriptions

Assign

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

Parameters

ADest: TAttributeSpecifier

ASrc: TAttributeSpecifier


Finalize

destructor Finalize


Initialize

constructor Initialize


Operator Descriptions

Equal(TAttributeSpecifier, Pointer)

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

Parameters

ALeft: TAttributeSpecifier

ARight: Pointer

Returns

Boolean


NotEqual(TAttributeSpecifier, Pointer)

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

Parameters

ALeft: TAttributeSpecifier

ARight: Pointer

Returns

Boolean


Method Descriptions

Attributes

Returns the underlying TAttributeSetView

function Attributes: TAttributeSetView; inline

Returns

TAttributeSetView


Define(String, String)

Defines a value for a specific key. A key is allowed to have multiple values.

function Define(const AKey, AValue: String): TResult<Void, TAttributeDefinitionError>

Parameters

AKey: String

AValue: String

Returns

TResult<Void, TAttributeDefinitionError>

Remarks

Use DefineUtf8 for a more efficient version that doesn't require UTF-8 conversion.


DefineUtf8(UTF8String, UTF8String)

Defines a value for a specific key. A key is allowed to have multiple values.

function DefineUtf8(const AKey, AValue: UTF8String): TResult<Void, TAttributeDefinitionError>; inline

Parameters

AKey: UTF8String

AValue: UTF8String

Returns

TResult<Void, TAttributeDefinitionError>


New

Creates a new TAttributeSpecifier.

class function New: TAttributeSpecifier; inline; static

Returns

TAttributeSpecifier