SDTUtils.GetText Method

Solclient

previous page next page

Solclient

SDTUtilsGetText Method

version: 7.2.1.27

If the message's binary payload contains a string, this method will return it. Otherwise it will return null.

Namespace: SolaceSystems.Solclient.Messaging.SDT
Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 7.2.1.27 (7.2.1.27)

Syntax

C++

Copy

public static string GetText(
	IMessage message
)

Public Shared Function GetText ( 
	message As IMessage
) As String

public:
static String^ GetText(
	IMessage^ message
)

Parameters

message: Type: SolaceSystems.Solclient.MessagingIMessage
The message to get the string from.

Return Value

Type: String
The string from the binary payload; or null, if none exists.

Exceptions

Exception	Condition
ArgumentNullException	Thrown when message is null.
OperationErrorException	Thrown when an error occurs. In this case ReturnCode and SDKErrorInfo are accessible from OperationErrorException and contain more information.
FatalErrorException	Thrown when an unrecoverable error occurs.

Reference

SDTUtils Class

SolaceSystems.Solclient.Messaging.SDT 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