ISession.ValidateTopic Method

Solclient

ISessionValidateTopic Method
version: 7.2.1.27
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.

Namespace: SolaceSystems.Solclient.Messaging
Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 7.2.1.27 (7.2.1.27)
Syntax
ReturnCode ValidateTopic(
	string topicName
)
Function ValidateTopic ( 
	topicName As String
) As ReturnCode
ReturnCode ValidateTopic(
	String^ topicName
)

Parameters

topicName
Type: SystemString

Return Value

Type: ReturnCode
SOLCLIENT_OK if successful; SOLCLIENT_FAIL if unsuccessful.
Exceptions
ExceptionCondition
FatalErrorException Thrown when an unrecoverable error occurs.
ArgumentNullException Thrown if any of the required parameters are null.
See Also