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().


Concept topic

Terms of Use | Rate this page

Last updated: 7 Dec 2005

© Copyright IBM Corporation 2005. All Rights Reserved.