STGMEDIUM - OLE Programmer's Reference (ole.hlp)

STGMEDIUM

The STGMEDIUM structure is a generalized global memory handle used for data transfer operations by the IAdviseSink, IDataObject, and IOleCache interfaces.

Defined in the IAdviseSink interface (advsnk.idl).

typedef struct tagSTGMEDIUM
{
DWORD tymed;
[switch_type(DWORD), switch_is((DWORD) tymed)]
union {
[case(TYMED_GDI)] HBITMAP hBitmap;
[case(TYMED_MFPICT)] HMETAFILEPICT hMetafilePict;
[case(TYMED_ENHMF)] HENHMETAFILE hEnhMetaFile;
[case(TYMED_HGLOBAL)] HGLOBAL hGlobal;
[case(TYMED_FILE)] LPWSTR lpszFileName;
[case(TYMED_ISTREAM)] IStream *pstm;
[case(TYMED_ISTORAGE)] IStorage *pstg;
[default] ;
};
[unique] IUnknown *pUnkForRelease;
}STGMEDIUM;
typedef STGMEDIUM *LPSTGMEDIUM;

Members
tymed

Indicates the type of storage medium. The marshaling and unmarshaling routines use this value to determine which union member was used. This value must be one of the elements of the TYMED enumeration.

union member
Specifies a handle, string, or interface pointer that the receiving process can use to access the data being transferred. If tymed is TYMED_NULL, the union member is undefined; otherwise, it is one of the following:

hBitmap

Specifies a bitmap handle. The tymed member is TYMED_GDI.

hMetafilePict

Specifies a metafile handle. The tymed member is TYMED_MFPICT.

hEnhMetaFile

Specifies an enhanced metafile handle. The tymed member is TYMED_ENHMF.

hGlobal

Specifies a global memory handle. The tymed member is TYMED_HGLOBAL.

lpszFileName

Specifies the path of a disk file that contains the data. The tymed member is TYMED_FILE.

pstm

Specifies an IStream instance. The tymed member is TYMED_ISTREAM.

pstg

Specifies an IStorage instance. The tymed member is TYMED_ISTORAGE.

pUnkForRelease

Points to an interface instance that allows the sending process to control the way the storage is released when the receiving process calls the ReleaseStgMedium API function. If pUnkForRelease is NULL, ReleaseStgMedium uses default procedures to release the storage; otherwise, ReleaseStgMedium uses the specified IUnknown interface.

See Also
FORMATETC, IAdviseSink, IDataObject, IOleCache, ReleaseStgMedium

More Online Helps

Win32 Programmer's Reference (win32.hlp)
Win32 Multimedia Programmer's Reference (mmedia.hlp)
Microsoft Windows Pen API Programmer's Reference (penapi.hlp)
Microsoft Windows Sockets 2 Reference (sock2.hlp)
Microsoft Windows Telephony API (TAPI) Programmer's Reference (sock2.hlp)
Unix Manual Pages

greatis just4fun network