|
DomainParticipantIgnoreSubscription Method
|
Instructs DDS to locally ignore a remote subscription. After this call, any data received related to that subscription will be ignored.
Namespace:
OpenDDSharp.DDS
Assembly:
OpenDDSharp (in OpenDDSharp.dll) Version: 0.5.0.0
Syntax public ReturnCode IgnoreSubscription(
InstanceHandle handle
)
Public Function IgnoreSubscription (
handle As InstanceHandle
) As ReturnCode
public:
ReturnCode IgnoreSubscription(
InstanceHandle handle
)
member IgnoreSubscription :
handle : InstanceHandle -> ReturnCode
Parameters
- handle
- Type: OpenDDSharp.DDSInstanceHandle
The InstanceHandle of the DataReader to be ignored.
Return Value
Type:
ReturnCodeThe
ReturnCode that indicates the operation result.
Remarks The DataReader to ignore is identified by the handle argument. This handle is the one that appears in the SampleInfo
retrieved when reading the data-samples from the built-in DataReader on the "DCPSSubscription" topic. To ignore a local DataReader, the handle can be obtained by
getting the InstanceHandle for the local DataReader.
There is no way to reverse this operation.
See Also