SAFEARRAY - OLE Programmer's Reference

OLE Programmer's Reference

Home Index About

Custom Search

SAFEARRAY

typedef struct FARSTRUCT tagSAFEARRAY {

unsigned short cDims; // Count of dimensions in this array.

unsigned short fFeatures; // Flags used by the SafeArray

// routines documented below:

#if defined(WIN32)

unsigned long cbElements; // Size of an element of the array;

// Does not include size of

// pointed-to data.

unsigned long cLocks; // Number of times the array has been

// locked without corresponding unlock.

#else

unsigned short cbElements;

unsigned short cLocks;

unsigned long handle; // Unused but kept for compatibility

#endif

oid HUGEP* pvData; // Pointer to the data.

SAFEARRAYBOUND rgsabound[1]; // One bound for each dimension.

} SAFEARRAY;

Note that the definition varies, depending on the target operating system platform. On 32-bit Windows systems, both the cbElements and cLocks parameters are unsigned long integers, and the handle parameter is omitted. On 16-bit Windows systems, cbElements and cLocks are unsigned short integers, and the handle parameter has been retained for compatibility with earlier software.

The array rgsabound is stored with the leftmost dimension in rgsabound[0] and the rightmost dimension in rgsabound[cDims

1]. If an array were specified in C-like syntax as a[2][5], it would have two elements in the rgsabound vector. Element 0 has an lLbound of 0 and a cElements of 2. Element 1 has an lLbound of 0 and a cElements of 5.

The fFeatures flags describe attributes of an array that may affect how the array is released. This allows freeing the array without referencing its containing variant. The bits are accessed using the following constants:

#define FADF_AUTO 0x0001 // Array is allocated on the stack.

#define FADF_STATIC 0x0002 // Array is statically allocated.

#define FADF_EMBEDDED 0x0004 // Array is embedded in a structure.

#define FADF_FIXEDSIZE 0x0010 // Array may not be resized or

// reallocated.

#define FADF_BSTR 0x0100 // An array of BSTRs.

#define FADF_UNKNOWN 0x0200 // An array of IUnknown*.

#define FADF_DISPATCH 0x0400 // An array of IDispatch*.

#define FADF_VARIANT 0x0800 // An array of VARIANTs.

#define FADF_RESERVED 0xF0E8 // Bits reserved for future use.

Last news from Greatis Software

    Nostalgia .Net     .Net is powerful, but not all-powerful, so sometimes we need to use Win32 API for our .Net applications. It's simple enough with Platform Invoke if you have Win32 skill, but we do not always have time to dig the ancient documentation, declare the special types that are compatible with Win32, find the values of the Win32's constants and so on. Nostalgia .Net offers several simple-to-use classes, and components that will allow you to forget about the headache of Win32 and just use the power of Win32 in your application the same way as you use the native. Net classes. More »

Recommended software for developers

    Ultimate Pack     Component pack for Delphi and C++ Builder that contains runtime form designer, runtime object inspector, print suite and much more for the very special price. More »

    Form Designer .Net     Unique runtime form design solution that allows to edit any form in .Net WinForms application at runtime with full source codes for only 300 euro! More »

    Print Suite .Net     Print Suite .Net is a set of components for easy printing texts, images and grids from your WinForms applications. Full C# source codes are available More »

    Gradient Controls .Net     Gradient Controls .Net offers controls with gradient background feature. Labels, panels and so on... Full C# source codes are available More »

    Greatis iGrid     iGrid plots drawing grid right over your desktop, so you can use it everywhere, with any drawing application without any special plugins for different graphic editors. More »

All the contacts and projects

Dmitry Vasiliev (just.dmitry)

More Online Helps

Win32 Programmer's Reference
Win32 Multimedia Programmer's Reference
OLE Programmer's Reference
Microsoft Windows Pen API Programmer's Reference
Microsoft Windows Sockets 2 Reference
Microsoft Windows Telephony API (TAPI) Programmer's Reference
Unix Manual Pages

greatis just4fun network