10.27.03

ISession.ValidateTopic Method

This method checks a topic string against topic encoding rules for the appliance. This method is intended for use before sending a message to a topic. This method should not be used with Subscribe methods. Subscribe methods perform its own topic validation, which includes accepting wildcards. For performance reasons Send(IMessage) and Send(IMessage[], Int32, Int32, Int32) does not validate topics, and this method is provided as a convenience to the developer to ensure a topic is valid before sending a message that could be rejected by the appliance. It is expected then that the same topic will be used for sending many messages.

Definition

Namespace: SolaceSystems.Solclient.Messaging
Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 10.27.0
C#
ReturnCode ValidateTopic(
	string topicName
)

Parameters

topicName  String

Return Value

ReturnCode
SOLCLIENT_OK if successful; SOLCLIENT_FAIL if unsuccessful.

Exceptions

FatalErrorException Thrown when an unrecoverable error occurs.
ArgumentNullException Thrown if any of the required parameters are null.

See Also