CanaimaSoft
f90SQL
Search
Contents
f90ADO
Links
f90VB
 
 
 
 
Summary of Procedures in f90VB's SafeArrays Library

The table below provides summary descriptions of the overloaded procedures included in the SafeArrays Library. For full descriptions, check the f90VB Reference Manual.

Procedure Name
Description
SafeArrayAccessData Allows access to the elements of a Safe Array using a mapped Fortran array. After a call to SafeArrayAccessData, the safe array is locked until you issue a call to SafeArrayUnAccessData. Changes made on the elements of the mapped Fortran array automatically become reflected in the corresponding elements of the Safe Array.
SafeArrayAllocData Allocates the memory for data-block based on a descriptor previously created with a call to SafeArrayAllocDescriptor.
SafeArrayAllocDescriptor Allocates a Safe Array descriptor structure and returns its handle.
SafeArrayCopy Creates a copy of an existing Safe Array.
SafeArrayCopyData Copies the source array to the target array after releasing any resources in the target array. This subroutine is similar to SafeArrayCopy, except that the target array has to be set up by the caller before the subroutine is called. The target is not allocated or reallocated.
SafeArrayCreate Subroutine SafeArrayCreate allocates a new Safe Array Descriptor and data-block. Depending on the syntactic variation used, the subroutine will also initialize the data-block of the Safe Array.
SafeArrayDestroy Destroys a Safe Array, releasing the memory used by its descriptor and data, and setting the Safe Array's handle to a null handle.
SafeArrayDestroyData Destroys the data associated to an existing Safe Array.
SafeArrayDestroyDescriptor Destroys an existing Safe Array descriptor. To destroy the corresponding Safe Array data, you must first call DestroySafeArrayData.
SafeArrayGetDim and SafeArrayDimensions Return the number of dimensions of an allocated Safe Array. SafeArrayGetDim and SafeArrayDimensions are two aliases for the same function.
SafeArrayGetElement Retrieves the value stored in an element of a Safe Array.
SafeArrayGetElementSize and SafeArrayElementSize Return the size (in bytes) of the elements of an array. SafeArrayGetElementSize and SafeArrayElementSize are two aliases for the same function.
SafeArrayGetFeatures and SafeArrayFeatures Return the contents of the fFeatures field of a Safe Array descriptor. SafeArrayGetFeatures and SafeArrayFeatures are two aliases for the same function.
SafeArrayGetLBound and SafeArrayLowerBound Return the lower bound of a dimension in a Safe Array. SafeArrayGetLBound is a subroutine. It returns the lower bound of a dimension in argument Bound. SafeArrayLowerBound is a function whose return value is the lower bound of the passed Safe Array dimension. Function SafeArrayLowerBound is usually more convenient to use when setting limits to the iterator of a DO loop.
SafeArrayGetLocks and SafeArrayLocks Return the number of locks on a Safe Array. SafeArrayGetLocks and SafeArrayLocks are two aliases for the same function.
SafeArrayGetNElements and SafeArrayNElements SafeArrayGetNElements is a subroutine. It returns the number of elements of a dimension in argument nElements. SafeArrayNElements is a function whose return value is the number of elements of the passed Safe Array dimension. Function SafeArrayNElements is usually more convenient to use when setting limits to the iterator of a DO loop.
SafeArrayGetUBound and SafeArrayUpperBound SafeArrayGetUBound is a subroutine. It returns the upper bound of a dimension in argument Bound. SafeArrayUpperBound is a function whose return value is the upper bound of the passed Safe Array dimension. Function SafeArrayUpperBound is usually more convenient to use when setting limits to the iterator of a DO loop.
SafeArrayGetVarType and SafeArrayVarType Return the VT-Type of the elements of a Safe Array. SafeArrayGetVarType is a subroutine. It returns the VT-Type of the array's elements in argument vtType. SafeArrayVarType is a function whose return value is the VT-Type of the elements in the passed Safe Array.
SafeArrayLock Adds a lock to the lock-counter of a Safe Array. A locked Safe Array cannot be redimensioned or destroyed. The array remains locked until SafeArrayUnlock is called.
SafeArrayPutElement Changes the value of an element of a Safe Array.
SafeArraySetBounds Sets the lower and upper bounds of a dimension in a Safe Array.
SafeArraySetElementSize Sets the size (in bytes) of the elements of an array.
SafeArraySetFeatures Sets the contents of the fFeatures field of a Safe Array descriptor.
SafeArrayUnAccessData Invalidates a Fortran array mapping created with SafeArrayAccessData and decreases the lock counter of the Safe Array.
SafeArrayUnlock Decreases the lock-counter of a Safe Array. A locked Safe Array cannot be redimensioned or destroyed.
SafeArrayReDim Re-dimensions a Safe Array preserving its current data. Only the number of elements in the last dimension of a Safe Array can be changed while preserving the current array's data.
SafeArrayGetElementPtr Returns the memory address of a Safe Array element. The array should be locked before this function is called.

Don't be decieved by the apparent similarity of names between SafeArrays Library procedures and Windows' own Safe Array API procedures. Most procedures in the SafeArrays Library greatly increase the functionality of Windows' API to make them easy and parctical to use from Fortran. Check the Reference Manual for full descriptions of these functions and subroutines

Copyright © 1998-2000 Canaima Software
For questions regarding this site, send an e-mail to
webmaster@canaimasoft.com