ISession.ValidateTopic Method

Solclient

previous page next page

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

C++

Copy

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

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

Reference

ISession Interface

SolaceSystems.Solclient.Messaging Namespace

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to use and copy the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

UNLESS STATED ELSEWHERE BETWEEN YOU AND SOLACE SYSTEMS, INC., THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Send comments on this topic to [email protected]

previous page start next page