WebSphere Message Service Clients for C/C++ and .NET, Version 1.2 Operating Systems: Linux, Windows

C++ methods that return a byte array

This topic describes the interface used by C++ methods that return a byte array.

In the C++ API, certain methods return a byte array as a parameter. Each of these methods uses the same interface for retrieving a byte array. Here is an example of one of these methods, PropertyContext.getBytesProperty():

xmsINT getBytesProperty(const String & propertyName,
                        xmsSBYTE *propertyValue,
                        const xmsINT length,
                        xmsINT *actualLength) const;

The way that the parameters propertyValue, length, and actualLength control the retrieval of the byte array is exactly the same as the way described in C functions that return a byte array by value.

Other examples of these methods are MapMessage.getBytes(), MapMessage.getObject(), Property.getByteArray(), and String.get().

Related concepts
Using namespaces in C++
Using the String class in C++
Getting and setting properties in C++
Assigning XMS objects in C++
Handling errors in C++
Using message and exception listeners in C++
Using the C API in a C++ application

Concept topic

Terms of Use | Rate this page

Last updated: 24 Mar 2006

© Copyright IBM Corporation 2005, 2006. All Rights Reserved.