TPortName
Represent the name for a port.
Definition
Unit: Neslib.Iceoryx2.Types
Properties
| Name | Description |
|---|---|
| Handle |
Constructors
| Name | Description |
|---|---|
| Assign | |
| Finalize | |
| Initialize |
Operators
| Name | Description |
|---|---|
| Equal | |
| NotEqual |
Methods
| Name | Description |
|---|---|
| AsView | Creates a TPortNameView. |
| Create | Creates a new port name. |
| CreateUtf8 | Creates a new port name. |
| ToString | Returns the string containing the port name. |
Property Descriptions
Handle
property Handle: THandle read GetHandle
Type: THandle
Constructor Descriptions
Assign
constructor Assign(var ADest: TPortName; const ASrc: TPortName)
Parameters
ADest: TPortName
ASrc: TPortName
Finalize
destructor Finalize
Initialize
constructor Initialize
Operator Descriptions
Equal(TPortName, Pointer)
class operator Equal(const ALeft: TPortName; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TPortName
ARight: Pointer
Returns
Boolean
NotEqual(TPortName, Pointer)
class operator NotEqual(const ALeft: TPortName; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TPortName
ARight: Pointer
Returns
Boolean
Method Descriptions
AsView
Creates a TPortNameView.
function AsView: TPortNameView; inline
Returns
Create(String)
Creates a new port name.
class function Create(const AName: String): TResult<TPortName, TSemanticStringError>; overload; inline; static
Parameters
AName: String
: The name of the port.
Returns
TResult<TPortName, TSemanticStringError>: A Result containing the port name or an error.
Remarks
Use CreateUtf8 for a more efficient version that bypasses UTF-8 conversion.
CreateUtf8(UTF8String)
Creates a new port name.
class function CreateUtf8(const AName: UTF8String): TResult<TPortName, TSemanticStringError>; inline; static
Parameters
AName: UTF8String
: The name of the port.
Returns
TResult<TPortName, TSemanticStringError>: A Result containing the port name or an error.
ToString
Returns the string containing the port name.
function ToString: String; inline
Returns
String