RTI Connext DDS Micro C API  Version 3.0.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
ENTITY_NAME

<<eXtension>> Name of the entity. More...

Data Structures

struct  DDS_EntityNameQosPolicy
 <<cert>> Policy used to name an entity. More...

Macros

#define DDS_ENTITYNAME_QOS_NAME_MAX   255
 Constant determining the maximum length of the name string contained in a DDS_EntityNameQosPolicy instance.

Functions

DDS_Boolean DDS_EntityNameQosPolicy_set_name (struct DDS_EntityNameQosPolicy *const self, const char *const name)
 Set the EntityName policy.

Variables

const char *const DDS_AUTO_NAME_ENTITY
 Constant used to request that an entity be assigned an automatically generated name.

Detailed Description

<<eXtension>> Name of the entity.


Macro Definition Documentation

#define DDS_ENTITYNAME_QOS_NAME_MAX   255

Constant determining the maximum length of the name string contained in a DDS_EntityNameQosPolicy instance.


Function Documentation

DDS_Boolean DDS_EntityNameQosPolicy_set_name ( struct DDS_EntityNameQosPolicy *const  self,
const char *const  name 
)

Set the EntityName policy.

Set the entity name Qos policy. The maximum allowed string length is DDS_ENTITYNAME_QOS_NAME_MAX (excluding the NUL character).

Parameters:
self<<in>> Cannot be NULL.
name<<in>> The entity name to assign to the policy
Returns:
DDS_BOOLEAN_TRUE on success, DDS_BOOLEAN_FALSE on failure

Variable Documentation

const char* const DDS_AUTO_NAME_ENTITY

Constant used to request that an entity be assigned an automatically generated name.


RTI Connext DDS Micro C API Version 3.0.3 Copyright © Wed Jun 24 2020 Real-Time Innovations, Inc