com.esri.arcgis.system
Interface IByteSwapStreamIO

All Superinterfaces:
Serializable
All Known Implementing Classes:
ByteSwapStreamIO

public interface IByteSwapStreamIO
extends Serializable

Provides access to members that support the Byte Swap Helper object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IStream getStream()
          The stream to perform byte swap reads and writes to.
 void read(int dataType, int pv, int cb, int[] pcbRead)
          Perform a read byte swapping to the native format.
 void setStreamByRef(IStream ppStream)
          The stream to perform byte swap reads and writes to.
 void write(int dataType, int pv, int cb, int[] pcbWritten)
          Perform a write byte swapping to the windows format.
 

Method Detail

setStreamByRef

void setStreamByRef(IStream ppStream)
                    throws IOException,
                           AutomationException
The stream to perform byte swap reads and writes to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ppStream - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStream

IStream getStream()
                  throws IOException,
                         AutomationException
The stream to perform byte swap reads and writes to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.system.IStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

read

void read(int dataType,
          int pv,
          int cb,
          int[] pcbRead)
          throws IOException,
                 AutomationException
Perform a read byte swapping to the native format.

Remarks

DataType [in]

User specified type of the data to perform swapping on.

pv [out]

A pointer to the buffer which the stream data is read into.

cb [in]

The number of bytes of data to read from the stream object.

pcbRead [out]

A pointer to a ULONG variable that receives the actual number of bytes

read from the stream object. It could be set to NULL. In this case,

the Read method does not provide the number of bytes read.

The Read method reads requested (in cb variable) number of bytes from the stream object into memory, starting at the current seek pointer, and swaps it into the native format. The actual number of bytes read can be less than it was requested if the end of the stream is reached during the read operation or an error can occur if nothing was read from the stream object.

VC++ example:

// Open the file and set it to be the stream object

IBlobStreamPtr ipBlobStream(CLSID_FileStream);
IFilePtr ipFile(ipBlobStream);
ipFile->Open(L"C:\\fileIn", esriReadOnly);
IStreamPtr ipStream(ipFile);
IByteSwapStreamIOPtr ipByteSwapStreamIO (CLSID_ByteSwapStreamIO);
ipByteSwapStreamIO->putref_Stream(ipStream);


// Get the size of the stream

unsigned long size;
ipBlobStream->get_Size(&size);


// Read and swap stream
BYTE pv[14];
ULONG pcbRead;
ipByteSwapStreamIO->Read(esriBSDTBYTE, &pv, size, &pcbRead);

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
dataType - A com.esri.arcgis.system.esriByteSwapDataType constant (in)
pv - A COM void* (out: use single element array)
cb - The cb (in)
pcbRead - The pcbRead (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

write

void write(int dataType,
           int pv,
           int cb,
           int[] pcbWritten)
           throws IOException,
                  AutomationException
Perform a write byte swapping to the windows format.

Remarks

DataType [in]

User specified type of the data to perform swapping on.

pv [in]

A pointer to the buffer which contains the data that is to be written

to the stream object. A valid parameter should be provided.

cb [in]

The number of bytes of data to attempt to write into the stream. The value

can be zero.

pcbRead [out]

A pointer to a ULONG variable that receives the actual number of bytes

written to the stream object. It could be set to NULL. In this case,

the Write method does not provide the number of bytes written.

The Write method writes the specified number of bytes of data to the Stream object and performs a byte swapping on it. The number of bytes actually written to the stream is returned in pcbWritten parameter. If the byte count variable (pv) is zero byte, no data is written to the stream, and the Write operation has no effect.

VC++ example:

// Open the file and set it to be the stream object
IBlobStreamPtr ipBlobStream(CLSID_FileStream);
IFilePtr ipFile(ipBlobStream);
ipFile->Open(L"C:\\fileIn", esriReadOnly);
IStreamPtr ipStream(ipFile);
IByteSwapStreamIOPtr ipByteSwapStreamIO (CLSID_ByteSwapStreamIO);
ipByteSwapStreamIO->putref_Stream(ipStream);


// Get the size of the stream

unsigned long size;
ipBlobStream->get_Size(&size);


// Read and swap stream

BYTE pv[14];
ULONG pcbRead;
ipByteSwapStreamIO->Read(esriBSDTBYTE, &pv, size, &pcbRead);


// Open a file to write the stream to

DeleteFileW(L"C:\\fileOut");
hr = ipFile->Open(L"C:\\fileOut", esriReadWrite);

// Write to the stream

ULONG pcbWritten;
ipByteSwapStreamIO->Write(esriBSDTBYTE, c_pv, size, &pcbWritten);

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
dataType - A com.esri.arcgis.system.esriByteSwapDataType constant (in)
pv - A COM void* (in)
cb - The cb (in)
pcbWritten - The pcbWritten (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.