Inside Macintosh: OpenDoc Cookbook / Part - Appendixes

Appendix A - OpenDoc Utilities

Storage (StorUtil)

This section describes the utilities defined in the files StorUtil.h and StorUtil.cpp. These utilities wrap the GetData methods of the class ODStorageUnit, letting you pass in direct pointers to data buffers instead of an ODByteArray wrapper.

Storage Utility Functions

The storage utility defines the functions described in the following sections.

StorageUnitGetValue

The StorageUnitGetValue function takes as a parameter a pointer to an OpenDoc storage unit, the SOM Environment variable, the buffer size, and a pointer to the buffer. The function returns the number of bytes actually read. The prototype of this function appears as follows:

ODULong     StorageUnitGetValue(ODStorageUnit* su, Environment* ev,
                  ODULong size, ODPtr buffer);

StorageUnitViewGetValue

The StorageUnitViewGetValue function takes as a parameter a pointer to an OpenDoc storage unit view object, the SOM Environment variable, the buffer size, and a pointer to the buffer. The function returns the number of bytes actually read. The prototype of this function appears as follows:

ODULong     StorageUnitViewGetValue(ODStorageUnitView* suv,
                  Environment* ev, ODULong size, ODPtr buffer);