Name: COM GUID A4DA1FD4-960A-42FD-BF9D-52956F07CDF Version 1.0
Interface IDispatch
IDispatch Interface
Enums
DVASPECT
The DVASPECT enumeration values specify the desired data or view aspect of the object when drawing or getting data.
DVASPECT_CONTENT = &H1
Provides a representation of an object so it can be displayed as an embedded object inside of a container. This value is typically specified for compound document objects. The presentation can be provided for the screen or printer.
DVASPECT_THUMBNAIL = &H2
Provides a thumbnail representation of an object so it can be displayed in a browsing tool. The thumbnail is approximately a 120 by 120 pixel, 16-color (recommended) device-independent bitmap potentially wrapped in a metafile.
DVASPECT_ICON = &H4
Provides an iconic representation of an object.
DVASPECT_DOCPRINT = &H8
Provides a representation of the object on the screen as though it were printed to a printer using the Print command from the File menu. The described data may represent a sequence of pages.
DVASPECT2
The DVASPECT2 enumeration value is used in IViewObject::Draw to specify new drawing aspects used to optimize the drawing process.
DVASPECT_OPAQUE = &H10
Represents the opaque, easy to clip parts of an object. Objects may or may not support this aspect.
DVASPECT_TRANSPARENT = &H20
Represents the transparent or irregular parts of on object, typically parts that are expensive or impossible to clip out. Objects may or may not support this aspect.
OLEVERBATTRIB
The OLEVERBATTRIB enumeration constants are used in the OLEVERB structure to describe the attributes of a specified verb for an object.
OLEVERBATTRIB_NEVERDIRTIES = &H1
Executing this verb will not cause the object to become dirty and is therefore in need of saving to persistent storage.
OLEVERBATTRIB_ONCONTAINERMENU = &H2
Indicates a verb that should appear in the container's menu of verbs for this object. OLEIVERB_HIDE, OLEIVERB_SHOW, and OLEIVERB_OPEN never have this value set.
OLEWHICHMK
The OLEWHICHMK enumeration constants indicate which part of an object's moniker is being set or retrieved. These constants are used in the IOleObject and IOleClientSite interfaces.
OLEWHICHMK_CONTAINER = &H1
The moniker of the object's container. Typically, this is a file moniker. This moniker is not persistently stored inside the object, since the container can be renamed even while the object is not loaded.
OLEWHICHMK_OBJREL = &H2
The moniker of the object relative to its container. Typically, this is an item moniker, and it is part of the persistent state of the object.
OLEWHICHMK_OBJFULL = &H3
The full moniker of the object. Binding to this moniker results in a connection to the object. This moniker is not persistently stored inside the object, since the container can be renamed even while the object is not loaded.
USERCLASSTYPE
The USERCLASSTYPE enumeration constants indicate the different variants of the display name associated with a class of objects. They are used in the IOleObject::GetUserType method and the OleRegGetUserType function.
USERCLASSTYPE_FULL = &H1
The full type name of the class.
USERCLASSTYPE_SHORT = &H2
A short name (maximum of 15 characters) that is used for popup menus and the Links dialog box.
USERCLASSTYPE_APPNAME = &H3
The name of the application servicing the class and is used in the Result text in dialog boxes.
XFORMCOORDS
Use by the IOleControlSite::TransformCoords functions
XFORMCOORDS_POSITION = &H1
The coordinates to convert represent a position point. Cannot be used with XFORMCOORDS_SIZE.
XFORMCOORDS_SIZE = &H2
The coordinates to convert represent a set of dimensions. Cannot be used with XFORMCOORDS_POSITION.
XFORMCOORDS_HIMETRICTOCONTAINER = &H4
The operation converts pptlHimetric into pptfContainer. Cannot be used with XFORMCOORDS_CONTAINERTOHIMETRIC.
XFORMCOORDS_CONTAINERTOHIMETRIC = &H8
The operation converts pptfContainer into pptlHimetric. Cannot be used with XFORMCOORDS_HIMETRICTOCONTAINER.
CTRLINFOFLAGS
CTRLINFO_EATS_RETURN = &H1
When the control has the focus, it will process the Return key.
CTRLINFO_EATS_ESCAPE = &H2
When the control has the focus, it will process the Escape key.
LOCKTYPE
The LOCKTYPE enumeration values indicate the type of locking requested for the specified range of bytes. The values are used in the ILockBytes::LockRegion and IStream::LockRegion methods.
LOCK_WRITE = &H1
If this lock is granted, the specified range of bytes can be opened and read any number of times, but writing to the locked range is prohibited except for the owner that was granted this lock.
LOCK_EXCLUSIVE = &H2
If this lock is granted, writing to the specified range of bytes is prohibited except by the owner that was granted this lock.
LOCK_ONLYONCE = &H4
If this lock is granted, no other LOCK_ONLYONCE lock can be obtained on the range. Usually this lock type is an alias for some other lock type. Thus, specific implementations can have additional behavior associated with this lock type.
STGTY
The STGTY enumeration values are used in the type member of the STATSTG structure to indicate the type of the storage element. A storage element is a storage object, a stream object, or a byte-array object (LOCKBYTES).
STGTY_STORAGE = &H1
Indicates that the storage element is a storage object.
STGTY_STREAM = &H2
Indicates that the storage element is a stream object.
STGTY_LOCKBYTES = &H3
Indicates that the storage element is a byte-array object.
STGTY_PROPERTY = &H4
Indicates that the storage element is a property storage object.
STREAM_SEEK
The STREAM_SEEK enumeration values specify the origin from which to calculate the new seek-pointer location. They are used for the dworigin parameter in the IStream::Seek method.
STREAM_SEEK_SET = &H0
The new seek pointer is an offset relative to the beginning of the stream. In this case, the dlibMove parameter is the new seek position relative to the beginning of the stream.
STREAM_SEEK_CUR = &H1
The new seek pointer is an offset relative to the current seek pointer location. In this case, the dlibMove parameter is the signed displacement from the current seek position.
STREAM_SEEK_END = &H2
The new seek pointer is an offset relative to the end of the stream. In this case, the dlibMove parameter is the new seek position relative to the end of the stream.
REGKIND
REGKIND_DEFAULT = &H0
REGKIND_REGISTER = &H1
REGKIND_NONE = &H2
PARAMFLAGS
PARAMFLAG_NONE = &H0
PARAMFLAG_FIN = &H1
PARAMFLAG_FOUT = &H2
PARAMFLAG_FLCID = &H4
PARAMFLAG_FRETVAL = &H8
PARAMFLAG_FOPT = &H10
PARAMFLAG_FHASDEFAULT = &H20
IDLFLAGS
IDLFLAG_NONE = &H0
IDLFLAG_FIN = &H1
IDLFLAG_FOUT = &H2
IDLFLAG_FLCID = &H4
IDLFLAG_FRETVAL = &H8
VARKIND
VAR_PERINSTANCE = &H0
VAR_STATIC = &H1
VAR_CONST = &H2
VAR_DISPATCH = &H3
VARFLAGS
VARFLAG_FREADONLY = &H1
VARFLAG_FSOURCE = &H2
VARFLAG_FBINDABLE = &H4
VARFLAG_FREQUESTEDIT = &H8
VARFLAG_FDISPLAYBIND = &H10
VARFLAG_FDEFAULTBIND = &H20
VARFLAG_FHIDDEN = &H40
VARFLAG_FRESTRICTED = &H80
VARFLAG_FDEFAULTCOLLELEM = &H100
VARFLAG_FUIDEFAULT = &H200
VARFLAG_FNONBROWSABLE = &H400
VARFLAG_FREPLACEABLE = &H800
VARFLAG_FIMMEDIATEBIND = &H1000
IMPLTYPEFLAGS
IMPLTYPEFLAG_FDEFAULT = &H1
IMPLTYPEFLAG_FSOURCE = &H2
IMPLTYPEFLAG_FRESTRICTED = &H4
IMPLTYPEFLAG_FDEFAULTVTABLE = &H800
CALLCONV
Identifies the calling convention used by a member function described in the METHODDATA structure.
CC_CDECL = &H1
CC_MSCPASCAL = &H2
CC_PASCAL = &H2
CC_MACPASCAL = &H3
CC_STDCALL = &H4
CC_RESERVED = &H5
CC_SYSCALL = &H6
CC_MPWCDECL = &H7
CC_MPWPASCAL = &H8
CC_MAX = &H9
Types
LONGLONG
LowPart As Long
HighPart As Long
ULONGLONG
LowPart As Long
HighPart As Long
LARGE_INTEGER
LowPart As Long
HighPart As Long
ULARGE_INTEGER
LowPart As Long
HighPart As Long
POINTL
x As Long
y As Long
CLSID
Data1 As Long
Data2 As Integer
Data3 As Integer
Data4 As Fixed Array
FILETIME
dwLowDateTime As Long
dwHighDateTime As Long
POINT
x As Long
y As Long
POINTF
x As Single
y As Single
SIZE
CX As Long
CY As Long
RECT
Left As Long
Top As Long
Right As Long
Bottom As Long
MSG
hWnd As Long
Message As Long
wParam As Long
lParam As Long
Time As Long
Pt As POINT
ACCEL
fVirt As Byte
Key As Integer
CmdID As Integer
OLEVERBSTRUCT
lVerb As Long
lpszVerbName As Long
fuFlags As Long
grfAttribs As Long
OLEINPLACEFRAMEINFO
cb As Long
fMDIApp As Long
hWndFrame As Long
haccel As Long
cAccelEntries As Long
OLEMENUGROUPWIDTHS
Width As Fixed Array
CALPOLESTR
cElems As Long
pElems As Long
CADWORD
cElems As Long
pElems As Long
SAFEARRAYBOUND
cElements As Long
lLbound As Long
IDLDESC
dwReserved As Long
wIDLFlags As Integer
DISPPARAMS
rgvarg As Long
rgdispidNamedArgs As Long
cArgs As Long
cNamedArgs As Long
Functions
GetTypeInfoCount
Retrieves the number of type information interfaces that an object provides (either 0 or 1). Function GetTypeInfoCount (ByRef pctInfo As Long) As Long
GetTypeInfo
Retrieves the type information for an object, which can then be used to get the type information for an interface. Function GetTypeInfo (ByVal itinfo As Long, ByVal lcid As Long, ByRef pptinfo As Long) As Long
GetIDsOfNames
Maps a single member and an optional set of argument names to a corresponding set of integer DISPIDs Function GetIDsOfNames (ByRef riid As CLSID, ByRef rgszNames As String, ByVal cNames As Long, ByVal lcid As Long, ByRef rgdispid As Long) As Long
Invoke
Provides access to properties and methods exposed by an object Function Invoke (ByVal dispidMember As Long, ByRef riid As CLSID, ByVal lcid As Long, ByVal wFlags As Integer, ByRef pdispparams As DISPPARAMS, ByRef pvarResult As Variant, ByRef pexcepinfo As EXCEPINFO, ByRef puArgErr As Long) As Long
Interface IEnumFORMATETC
IEnumFORMATETC interface
Types
DVTARGETDEVICE
tdSize As Long
tdDriverNameOffset As Integer
tdDeviceNameOffset As Integer
tdPortNameOffset As Integer
tdExtDevmodeOffset As Integer
tdData As Fixed Array
FORMATETC
cfFormat As Long
ptd As DVTARGETDEVICE
dwAspect As Long
lindex As Long
tymed As Long
STGMEDIUM
tymed As Long
pmed As Long
pUnkForRelease As IUnknown
Functions
Next
Retrieves a specified number of items in the enumeration sequence. Function Next (ByVal Celt As Long, ByRef rgElt As FORMATETC, ByRef pCeltFetched As Long) As Long
Skip
Skips over a specified number of items in the enumeration sequence. Function Skip (ByVal Celt As Long) As Long
Reset
Resets the enumeration sequence to the beginning. Function Reset () As Long
Clone
Creates another enumerator that contains the same enumeration state as the current one. Function Clone (ByRef ppEnum As IEnumVARIANT) As Long
Interface IEnumMoniker
IEnumMoniker interface
Functions
Next
Retrieves a specified number of items in the enumeration sequence. Function Next (ByVal Celt As Long, ByRef rgElt As IMoniker, ByVal pCeltFetched As Long) As Long
Skip
Skips over a specified number of items in the enumeration sequence. Function Skip (ByVal Celt As Long) As Long
Reset
Resets the enumeration sequence to the beginning. Function Reset () As Long
Clone
Creates another enumerator that contains the same enumeration state as the current one. Function Clone (ByRef ppEnum As IMoniker) As Long
Interface IEnumOLEVERB
IEnumOLEVERB Interface
Functions
Next
Retrieves a specified number of items in the enumeration sequence. Function Next (ByVal Celt As Long, ByRef rgElt As OLEVERBSTRUCT, ByRef pCeltFetched As Long) As Long
Skip
Skips over a specified number of items in the enumeration sequence. Function Skip (ByVal Celt As Long) As Long
Reset
Resets the enumeration sequence to the beginning. Function Reset () As Long
Clone
Creates another enumerator that contains the same enumeration state as the current one. Function Clone (ByRef ppEnum As IEnumOLEVERB) As Long
Interface IEnumSTATDATA
IEnumSTATDATA interface
Types
STATDATA
FORMATETC As FORMATETC
grfAdvf As Long
pAdvSink As IAdviseSink
dwConnection As Long
Functions
Next
Retrieves a specified number of items in the enumeration sequence. Function Next (ByVal Celt As Long, ByRef rgElt As STATDATA, ByRef pCeltFetched As Long) As Long
Skip
Skips over a specified number of items in the enumeration sequence. Function Skip (ByVal Celt As Long) As Long
Reset
Resets the enumeration sequence to the beginning. Function Reset () As Long
Clone
Creates another enumerator that contains the same enumeration state as the current one. Function Clone (ByRef ppEnum As IEnumSTATDATA) As Long
Interface IEnumString
IEnumVARIANT interface
Functions
Next
Retrieves a specified number of items in the enumeration sequence. Function Next (ByVal Celt As Long, ByRef rgElt As String, ByVal pCeltFetched As Long) As Long
Skip
Skips over a specified number of items in the enumeration sequence. Function Skip (ByVal Celt As Long) As Long
Reset
Resets the enumeration sequence to the beginning. Function Reset () As Long
Clone
Creates another enumerator that contains the same enumeration state as the current one. Function Clone (ByRef ppEnum As IEnumString) As Long
Interface IEnumVARIANT
IEnumVARIANT interface
Functions
Next
Retrieves a specified number of items in the enumeration sequence. Function Next (ByVal Celt As Long, ByRef rgVar As Variant, ByVal pCeltFetched As Long) As Long
Skip
Skips over a specified number of items in the enumeration sequence. Function Skip (ByVal Celt As Long) As Long
Reset
Resets the enumeration sequence to the beginning. Function Reset () As Long
Clone
Creates another enumerator that contains the same enumeration state as the current one. Function Clone (ByRef ppEnum As IEnumVARIANT) As Long
Interface IStream
IStream Interface.
Types
STATSTG
pwcsName As String
type As Long
cbSize As Currency
mtime As Currency
ctime As Currency
atime As Currency
grfMode As Long
grfLocksSupported As Long
CLSID As CLSID
grfStateBits As Long
reserved As Long
Functions
Read
Reads a specified number of bytes from the stream object into memory starting at the current seek pointer. Function Read (ByRef pv As Any, ByVal cb As Long, ByRef pcbRead As Long) As Long
Write
Writes a specified number of bytes into the stream object starting at the current seek pointer. Function Write (ByRef pv As Any, ByVal cb As Long, ByRef pcbWritten As Long) As Long
Seek
Changes the seek pointer to a new location relative to the beginning of the stream, to the end of the stream, or to the current seek pointer. Function Seek (ByRef dlibMove As LARGE_INTEGER, ByVal dwOrigin As Long, ByRef plibNewPosition As ULARGE_INTEGER) As Long
SetSize
Changes the size of the stream object. Function SetSize (ByRef libNewSize As ULARGE_INTEGER) As Long
CopyTo
Copies a specified number of bytes from the current seek pointer in the stream to the current seek pointer in another stream. Function CopyTo (ByRef pstm As IStream, ByRef cb As ULARGE_INTEGER, ByRef pcbRead As ULARGE_INTEGER, ByRef pcbWritten As ULARGE_INTEGER) As Long
Commit
Ensures that any changes made to a stream object open in transacted mode are reflected in the parent storage. Function Commit (ByVal grfCommitFlags As Long) As Long
Revert
Discards all changes that have been made to a transacted stream since the last IStream.Commit call. Function Revert () As Long
LockRegion
Restricts access to a specified range of bytes in the stream. Supporting this functionality is optional since some file systems do not provide it. Function LockRegion (ByRef libOffset As ULARGE_INTEGER, ByRef cb As ULARGE_INTEGER, ByVal dwLockType As Long) As Long
UnlockRegion
Removes the access restriction on a range of bytes previously restricted with IStream.LockRegion. Function UnlockRegion (ByRef libOffset As ULARGE_INTEGER, ByRef cb As ULARGE_INTEGER, ByVal dwLockType As Long) As Long
Stat
Retrieves the STATSTG structure for this stream. Function Stat (ByRef pstatstg As STATSTG, ByVal grfStatFlag As Long) As Long
Clone
Creates a new stream object with its own seek pointer that references the same bytes as the original stream. Function Clone (ByRef ppstm As IStream) As Long
Interface IPersist
IPersist Interface.
Functions
GetClassID
Retrieves the class identifier (CLSID) of an object. The CLSID is a unique value that identifies the code that can manipulate the persistent data. Function GetClassID (ByRef pClassID As CLSID) As Long
Interface IPersistStream
IPersistStream Interface.
Functions
IsDirty
Checks the object for changes since it was last saved. Function IsDirty () As Long
Load
Initializes an object from the stream where it was previously saved. Function Load (ByRef pstm As IStream) As Long
Save
Saves an object to the specified stream. Function Save (ByRef pstm As IStream, ByVal fClearDirty As Long) As Long
GetSizeMax
Returns the size in bytes of the stream needed to save the object. Function GetSizeMax (ByRef pcbSize As ULARGE_INTEGER) As Long
Interface IRunningObjectTable
IRunningObjectTable Interface.
Functions
Register
Registers an object and its identifying moniker in the Running Object Table (ROT). Function Register (ByVal grfFlags As Long, ByVal punkObject As IUnknown, ByRef pmkObjectName As IMoniker, ByRef pdwRegister As Long) As Long
Revoke
Removes from the Running Object Table (ROT) an entry that was previously registered by a call to IRunningObjectTable.Register. Function Revoke (ByVal dwRegister As Long) As Long
IsRunning
Determines whether the object identified by the specified moniker is currently running. This method looks for the moniker in the Running Object Table (ROT). Function IsRunning (ByRef pmkObjectName As IMoniker) As Long
GetObject
Determines whether the object identified by the specified moniker is running, and if it is, retrieves a pointer to that object. This method looks for the moniker in the Running Object Table (ROT), and retrieves the pointer registered there. Function GetObject (ByRef pmkObjectName As IMoniker, ByRef ppunkObject As IUnknown) As Long
NoteChangeTime
Records the time that a running object was last modified. The object must have previously been registered with the Running Object Table (ROT). This method stores the time of last change in the ROT. Function NoteChangeTime (ByVal dwRegister As Long, ByRef pfiletime As FILETIME) As Long
GetTimeOfLastChange
Returns the time that an object was last modified. The object must have previously been registered with the Running Object Table (ROT). This method looks for the last change time recorded in the ROT. Function GetTimeOfLastChange (ByRef pmkObjectName As IMoniker, ByRef pfiletime As FILETIME) As Long
EnumRunning
Creates and returns a pointer to an enumerator that can list the monikers of all the objects currently registered in the Running Object Table (ROT). Function EnumRunning (ByRef ppenumMoniker As IEnumMoniker) As Long
Interface IBindCtx
IBindCtx Interface.
Types
BIND_OPTS
cbStruct As Long
grfFlags As Long
grfMode As Long
dwTickCountDeadline As Long
Functions
RegisterObjectBound
Calls IUnknown::AddRef on the specified object to ensure that the object remains active until the bind context is released. The method stores a pointer to the object in the bind context's internal list of pointers. Function RegisterObjectBound (ByVal punk As IUnknown) As Long
RevokeObjectBound
Releases the IUnknown pointer to the specified object and removes that pointer from the bind context's internal list of pointers. This undoes a previous call to IBindCtx.RegisterObjectBound for the same object. Function RevokeObjectBound (ByVal punk As IUnknown) As Long
ReleaseBoundObjects
Releases all pointers to all objects that were previously registered by calls to IBindCtx.RegisterObjectBound. Function ReleaseBoundObjects () As Long
SetBindOptions
Specifies new values for the binding parameters stored in the bind context. Subsequent binding operations can call IBindCtx.GetBindOptions to retrieve the parameters. Function SetBindOptions (ByRef pbindopts As BIND_OPTS) As Long
GetBindOptions
Returns the binding options stored in this bind context. Function GetBindOptions (ByRef pbindopts As BIND_OPTS) As Long
GetRunningObjectTable
Provides an interface pointer to the Running Object Table (ROT) for the machine on which this bind context is running. Function GetRunningObjectTable (ByRef pprot As IRunningObjectTable) As Long
RegisterObjectParam
Stores an IUnknown pointer on the specified object under the specified key in the bind context's string-keyed table of pointers. The method must call IUnknown.AddRef on the stored pointer. Function RegisterObjectParam (ByVal pszKey As String, ByVal punk As IUnknown) As Long
GetObjectParam
Retrieves the pointer associated with the specified key in the bind context's string-keyed table of pointers. Function GetObjectParam (ByVal pszKey As String, ByRef ppunk As IUnknown) As Long
EnumObjectParam
Supplies a pointer to an IEnumString interface on an enumerator that can return the keys of the bind context's string-keyed table of pointers. Function EnumObjectParam (ByRef ppEnum As IEnumString) As Long
RevokeObjectParam
Removes the specified key and its associated pointer from the bind context's string-keyed table of objects. The key must have previously been inserted into the table with a call to IBindCtx.RegisterObjectParam. Function RevokeObjectParam (ByVal pszKey As String) As Long
Interface IMoniker
IMoniker Interface.
Functions
BindToObject
Uses the moniker to bind to the object it identifies. The binding process involves finding the object, putting it into the running state if necessary, and supplying the caller with a pointer to a specified interface on the identified object. Function BindToObject (ByRef pbc As IBindCtx, ByRef pmkToLeft As IMoniker, ByRef riidResult As CLSID, ByRef ppvResult As Any) As Long
BindToStorage
Retrieves an interface pointer to the storage that contains the object identified by the moniker. Unlike the IMoniker.BindToObject method, this method does not activate the object identified by the moniker. Function BindToStorage (ByRef pbc As IBindCtx, ByRef pmkToLeft As IMoniker, ByRef riid As CLSID, ByRef ppvObj As Any) As Long
Reduce
Returns a reduced moniker—that is, another moniker that refers to the same object as this moniker but can be bound with equal or greater efficiency. Function Reduce (ByRef pbc As IBindCtx, ByVal dwReduceHowFar As Long, ByRef ppmkToLeft As IMoniker, ByRef ppmkReduced As IMoniker) As Long
ComposeWith
Combines the current moniker with another moniker, creating a new composite moniker. Function ComposeWith (ByRef pmkRight As IMoniker, ByVal fOnlyIfNotGeneric As Long, ByRef ppmkComposite As IMoniker) As Long
Enum
Supplies a pointer to an enumerator that can enumerate the components of a composite moniker. Function Enum (ByVal fForward As Long, ByRef ppenumMoniker As IEnumMoniker) As Long
IsEqual
Compares this moniker with a specified moniker and indicates whether they are identical. Function IsEqual (ByRef pmkOtherMoniker As IMoniker) As Long
Hash
Calculates a 32-bit integer using the internal state of the moniker. Function Hash (ByRef pdwHash As Long) As Long
GetTimeOfLastChange
Provides a number representing the time the object identified by this moniker was last changed. Function GetTimeOfLastChange (ByRef pbc As IBindCtx, ByRef pmkToLeft As IMoniker, ByRef pfiletime As FILETIME) As Long
Inverse
Provides a moniker that, when composed to the right of this moniker or one of similar structure, will destroy it. (The moniker will compose to nothing.) Function Inverse (ByRef ppmk As IMoniker) As Long
CommonPrefixWith
Creates a new moniker based on the common prefix that this moniker (the one comprising the data of this moniker object) shares with another moniker. Function CommonPrefixWith (ByRef pmkOther As IMoniker, ByRef ppmkPrefix As IMoniker) As Long
RelativePathTo
Supplies a moniker that, when composed onto the end of this moniker (or one with a similar structure), yields the specified moniker. Function RelativePathTo (ByRef pmkOther As IMoniker, ByRef ppmkRelPath As IMoniker) As Long
GetDisplayName
Gets the display name, which is a user-readable representation of this moniker. Function GetDisplayName (ByRef pbc As IBindCtx, ByRef pmkToLeft As IMoniker, ByRef ppszDisplayName As String) As Long
ParseDisplayName
Reads as many characters of the specified display name as it understands and builds a moniker corresponding to the portion read; this procedure is known as parsing the display name. Function ParseDisplayName (ByRef pbc As IBindCtx, ByRef pmkToLeft As IMoniker, ByVal pszDisplayName As String, ByRef pchEaten As Long, ByRef ppmkOut As IMoniker) As Long
IsSystemMoniker
Indicates whether this moniker is of one of the system-supplied moniker classes. Function IsSystemMoniker (ByRef pdwMksys As Long) As Long
Interface IAdviseSink
IAdviseSink Interface.
Functions
OnDataChange
Called by the server to notify a data object's currently registered advise sinks that data in the object has changed. Function OnDataChange (ByRef pFormatetc As FORMATETC, ByRef pStgmed As STGMEDIUM) As Any
OnViewChange
Notifies an object's registered advise sinks that its view has changed. Function OnViewChange (ByVal dwAspect As Long, ByVal lindex As Long) As Any
OnRename
Called by the server to notify all registered advisory sinks that the object has been renamed. Function OnRename (ByRef pmk As IMoniker) As Any
OnSave
Called by the server to notify all registered advisory sinks that the object has been saved. Function OnSave () As Any
OnClose
Called by the server to notify all registered advisory sinks that the object has changed from the running to the loaded state. Function OnClose () As Any
Interface IDataObject
IDataObject Interface.
Functions
GetData
Called by a data consumer to obtain data from a source data object. The GetData method renders the data described in the specified FORMATETC structure and transfers it through the specified STGMEDIUM structure. Function GetData (ByRef pFormatetc As FORMATETC, ByRef pmedium As STGMEDIUM) As Long
GetDataHere
Called by a data consumer to obtain data from a source data object. This method differs from the GetData method in that the caller must allocate and free the specified storage medium. Function GetDataHere (ByRef pFormatetc As FORMATETC, ByRef pmedium As STGMEDIUM) As Long
QueryGetData
Determines whether the data object is capable of rendering the data described in the FORMATETC structure. Function QueryGetData (ByRef pFormatetc As FORMATETC) As Long
GetCanonicalFormatEtc
Provides a standard FORMATETC structure that is logically equivalent to one that is more complex. You use this method to determine whether two different FORMATETC structures would return the same data, removing the need for duplicate rendering. Function GetCanonicalFormatEtc (ByRef pFormatetcIn As FORMATETC, ByRef pFormatetcOut As FORMATETC) As Long
SetData
Called by an object containing a data source to transfer data to the object that implements this method. Function SetData (ByRef pFormatetc As FORMATETC, ByRef pmedium As STGMEDIUM, ByVal fRelease As Long) As Long
EnumFormatEtc
Creates an object for enumerating the FORMATETC structures for a data object. These structures are used in calls to IDataObject.GetData or IDataObject.SetData. Function EnumFormatEtc (ByVal dwDirection As Long, ByRef ppenumFormatetc As IEnumFORMATETC) As Long
DAdvise
Called by an object supporting an advise sink to create a connection between a data object and the advise sink. This enables the advise sink to be notified of changes in the data of the object. Function DAdvise (ByRef pFormatetc As FORMATETC, ByVal advf As Long, ByRef pAdvSink As IAdviseSink, ByRef pdwConnection As Long) As Long
DUnadvise
Destroys a notification connection that had been previously set up. Function DUnadvise (ByVal dwConnection As Long) As Long
EnumDAdvise
Creates an object that can be used to enumerate the current advisory connections. Function EnumDAdvise (ByRef ppenumAdvise As IEnumSTATDATA) As Long
Interface IDropTarget
IDropTarget Interface.
Functions
DragEnter
Indicates whether a drop can be accepted, and, if so, the effect of the drop. Function DragEnter (ByRef pDataObject As IDataObject, ByVal grfKeyState As Long, ByRef Pt As POINTL, ByRef pdwEffect As Long) As Long
DragOver
Provides target feedback to the user and communicates the drop's effect to the DoDragDrop function so it can communicate the effect of the drop back to the source. Function DragOver (ByVal grfKeyState As Long, ByRef Pt As POINTL, ByRef pdwEffect As Long) As Long
DragLeave
Removes target feedback and releases the data object. Function DragLeave () As Long
Drop
Removes target feedback and releases the data object. Function Drop (ByRef pDataObject As IDataObject, ByVal grfKeyState As Long, ByRef Pt As POINTL, ByRef pdwEffect As Long) As Long
Interface ITypeLib
ITypeLib Interface
Enums
SYSKIND
SYS_WIN16 = &H0
SYS_WIN32 = &H1
SYS_MAC = &H2
LIBFLAGS
LIBFLAG_FRESTRICTED = &H1
LIBFLAG_FCONTROL = &H2
LIBFLAG_FHIDDEN = &H4
LIBFLAG_FHASDISKIMAGE = &H8
TYPEKIND
TKIND_ENUM = &H0
A set of enumerators.
TKIND_RECORD = &H1
A structure with no methods.
TKIND_MODULE = &H2
A module that can only have static functions and data (for example, a DLL).
TKIND_INTERFACE = &H3
A type that has virtual and pure functions.
TKIND_DISPATCH = &H4
A set of methods and properties that are accessible through IDispatch::Invoke. By default, dual interfaces return TKIND_DISPATCH.
TKIND_COCLASS = &H5
A set of implemented component object interfaces.
TKIND_ALIAS = &H6
A type that is an alias for another type.
TKIND_UNION = &H7
A union, all of whose members have an offset of zero.
TKIND_MAX = &H8
End of ENUM marker.
Types
TLIBATTR
Contains information about a type library. Information from this structure is used to identify the type library and to provide national language support for member names.
guid As CLSID
Globally unique library ID
lcid As Long
Locale of the TypeLibrary.
SYSKIND As SYSKIND
Target hardware platform.
wMajorVerNum As Integer
Major version number.
wMinorVerNum As Integer
Minor version number.
wLibFlags As Integer
Library flags.
Functions
GetTypeInfoCount
Returns the number of type descriptions in the type library. Function GetTypeInfoCount () As Long
GetTypeInfo
Retrieves the specified type description in the library. Function GetTypeInfo (ByVal index As Long, ByRef pptinfo As ITypeInfo) As Long
GetTypeInfoType
Retrieves the type of a type description. Function GetTypeInfoType (ByVal index As Long, ByRef pTKind As TYPEKIND) As Long
GetTypeInfoOfGuid
Retrieves the type description that corresponds to the specified GUID. Function GetTypeInfoOfGuid (ByRef guid As CLSID, ByRef pptinfo As ITypeInfo) As Long
GetLibAttr
Retrieves the structure that contains the library's attributes. Function GetLibAttr (ByRef ppTLibAttr As Long) As Long
GetTypeComp
Enables a client compiler to bind to a library's types, variables, constants, and global functions. Function GetTypeComp (ByRef lpTComp As Long) As Long
GetDocumentation
Retrieves the library's documentation string, the complete Help file name and path, and the context identifier for the library Help topic in the Help file. Function GetDocumentation (ByVal index As Long, ByRef pBstrName As String, ByRef pBstrDocString As String, ByRef pdwHelpContext As Long, ByRef pBstrHelpFile As String) As Long
IsName
Indicates whether a passed-in string contains the name of a type or member described in the library. Function IsName (ByVal szNameBuf As String, ByVal lHashVal As Long, ByRef pfName As Long) As Long
FindName
Finds occurrences of a type description in a type library. This may be used to quickly verify that a name exists in a type library. Function FindName (ByVal szNameBuf As String, ByVal lHashVal As Long, ByRef pptinfo As ITypeInfo, ByRef rgMemId As Long, ByRef pcFound As Integer) As Long
ReleaseTLibAttr
Releases the TLIBATTR originally obtained from ITypeLib.GetLibAttr. Function ReleaseTLibAttr (ByVal pTLibAttr As Long) As Any
Interface ITypeInfo
ITypeInfo interface
Enums
TYPEFLAGS
TYPEFLAG_FAPPOBJECT = &H1
TYPEFLAG_FCANCREATE = &H2
TYPEFLAG_FLICENSED = &H4
TYPEFLAG_FPREDECLID = &H8
TYPEFLAG_FHIDDEN = &H10
TYPEFLAG_FCONTROL = &H20
TYPEFLAG_FDUAL = &H40
TYPEFLAG_FNONEXTENSIBLE = &H80
TYPEFLAG_FOLEAUTOMATION = &H100
TYPEFLAG_FRESTRICTED = &H200
TYPEFLAG_FAGGREGATABLE = &H400
TYPEFLAG_FREPLACEABLE = &H800
TYPEFLAG_FDISPATCHABLE = &H1000
FUNCKIND
FUNC_VIRTUAL = &H0
The function is accessed the same as PUREVIRTUAL, except the function has an implementation.
FUNC_PUREVIRTUAL = &H1
The function is accessed through the virtual function table (VTBL), and takes an implicit this pointer.
FUNC_NONVIRTUAL = &H2
The function is accessed by static address and takes an implicit this pointer.
FUNC_STATIC = &H3
The function is accessed by static address and does not take an implicit this pointer.
FUNC_DISPATCH = &H4
The function can be accessed only through IDispatch.
FUNCFLAGS
FUNCFLAG_FRESTRICTED = &H1
The function should not be accessible from macro languages. This flag is intended for system-level functions or functions that type browsers should not display.
FUNCFLAG_FSOURCE = &H2
The function returns an object that is a source of events.
FUNCFLAG_FBINDABLE = &H4
The function that supports data binding.
FUNCFLAG_FREQUESTEDIT = &H8
When set, any call to a method that sets the property results first in a call to IPropertyNotifySink::OnRequestEdit. The implementation of OnRequestEdit determines if the call is allowed to set the property.
FUNCFLAG_FDISPLAYBIND = &H10
The function that is displayed to the user as bindable. FUNC_FBINDABLE must also be set.
FUNCFLAG_FDEFAULTBIND = &H20
The function that best represents the object. Only one function in a type information can have this attribute.
FUNCFLAG_FHIDDEN = &H40
The function should not be displayed to the user, although it exists and is bindable.
FUNCFLAG_FUSESGETLASTERROR = &H80
The function supports GetLastError. If an error occurs during the function, the caller can call GetLastError to retrieve the error code.
FUNCFLAG_FDEFAULTCOLLELEM = &H100
Permits an optimization in which the compiler looks for a member named ”xyz” on the type of ”abc”.
FUNCFLAG_FUIDEFAULT = &H200
The type information member is the default member for display in the user interface.
FUNCFLAG_FNONBROWSABLE = &H400
The property appears in an object browser, but not in a properties browser.
FUNCFLAG_FREPLACEABLE = &H800
Tags the interface as having default behaviors.
FUNCFLAG_FIMMEDIATEBIND = &H1000
Mapped as individual bindable properties.
INVOKEKIND
INVOKE_FUNC = &H1
The member is called using a normal function invocation syntax.
INVOKE_PROPERTYGET = &H2
The function is invoked using a normal property-access syntax.
INVOKE_PROPERTYPUT = &H4
The function is invoked using a property value assignment syntax. Syntactically, a typical programming language might represent changing a property in the same way as assignment. For example: object.property : = value
INVOKE_PROPERTYPUTREF = &H8
The function is invoked using a property reference assignment syntax.
VARENUM
An enumeration type used in VARIANT, TYPEDESC, and safearrays. [V] - May appear in a VARIANT. [T] - May appear in a TYPEDESC. [P] - may appear in an OLE property set. [S] - May appear in a Safe Array.
VT_EMPTY = &H0
[V][ ][P][ ] Not specified.
VT_NULL = &H1
[V][ ][ ][ ] SQL-style Null.
VT_I2 = &H2
[V][T][P][S] 2-byte signed int.
VT_I4 = &H3
[V][T][P][S] 4-byte-signed int.
VT_R4 = &H4
[V][T][P][S] 4-byte real.
VT_R8 = &H5
[V][T][P][S] 8-byte real.
VT_CY = &H6
[V][T][P][S] Currency.
VT_DATE = &H7
[V][T][P][S] Date.
VT_BSTR = &H8
[V][T][P][S] Automation string.
VT_DISPATCH = &H9
[V][T][ ][S] IDispatch.Far*
VT_ERROR = &HA
[V][T][ ][S] Scodes.
VT_BOOL = &HB
[V][T][P][S] Boolean; True=-1, False=0.
VT_VARIANT = &HC
[V][T][P][S] VARIANT FAR*.
VT_UNKNOWN = &HD
[V][T][ ][S] IUnknown FAR*.
VT_DECIMAL = &HE
[V][T][ ][S] 16 byte fixed point.
VT_I1 = &H10
[V][T][ ][S] Char.
VT_UI1 = &H11
[V][T][ ][S] Unsigned char.
VT_UI2 = &H12
[V][T][ ][S] 2 byte unsigned int.
VT_UI4 = &H13
[V][T][ ][S] 4 byte unsigned int.
VT_I8 = &H14
VT_UI8 = &H15
VT_INT = &H16
[V][T] [S] Signed machine int.
VT_UINT = &H17
[V][T] [S] Unsigned machine int.
VT_VOID = &H18
[T] C-style void.
VT_HRESULT = &H19
[T]
VT_PTR = &H1A
[T] Pointer type.
VT_SAFEARRAY = &H1B
[T] Use VT_ARRAY in VARIANT.
VT_CARRAY = &H1C
[T] C-style array.
VT_USERDEFINED = &H1D
[T] User-defined type.
VT_LPSTR = &H1E
[T][P] Null-terminated string.
VT_LPWSTR = &H1F
[T][P] Wide null-terminated string.
VT_RECORD = &H24
[V] [P][S] User defined type
VT_FILETIME = &H40
[P] FILETIME
VT_BLOB = &H41
[P] Length prefixed bytes
VT_STREAM = &H42
[P] Name of the stream follows
VT_STORAGE = &H43
[P] Name of the storage follows
VT_STREAMED_OBJECT = &H44
[P] Stream contains an object
VT_STORED_OBJECT = &H45
[P] Storage contains an object
VT_BLOB_OBJECT = &H46
[P] Blob contains an object
VT_CF = &H47
[P] Clipboard format
VT_CLSID = &H48
[P] A Class ID
VT_BSTR_BLOB = &HFFF
VT_VECTOR = &H1000
[P] Simple counted array
VT_ARRAY = &H2000
[V] SAFEARRAY*.
VT_BYREF = &H4000
[V]
VT_RESERVED = &H8000
VT_ILLEGAL = &HFFFF
VT_ILLEGALMASKED = &HFFF
VT_TYPEMASK = &HFFF
Types
TYPEDESC
Describes the type of a variable, the return type of a function, or the type of a function parameter.
lpItemDesc As Long
vt As Long
Variable Type.
ARRAYDESC
tdescElem As TYPEDESC
cDims As Integer
rgbounds As Fixed Array
PARAMDESCEX
cBytes As Long
dwReserved As Long
varDefaultValue As Variant
PARAMDESC
Contains information needed for transferring a structure element, parameter, or function return value between processes.
lpParamDescEx As Long
wParamFlags As Integer
ELEMDESC
Includes the type description and process-transfer information for a variable, a function, or a function parameter.
tdesc As TYPEDESC
Type of the element.
PARAMDESC As PARAMDESC
Information about the parameter
FUNCDESC
Describes a function.
MemID As Long
Function Member ID
lprgSCode As Long
lprgElemDescParam As Long
FUNCKIND As FUNCKIND
Specifies whether the function is virtual, static, or dispatch-only.
InvKind As INVOKEKIND
Indicates if this is a property function, and if so, what kind.
CALLCONV As CALLCONV
Specifies the function's calling convention.
cParams As Integer
Count of total number of parameters.
cParamsOpt As Integer
Count of optional parameters (detailed description follows ).
oVft As Integer
For FUNC_VIRTUAL, specifies the offset in the VTBL.
cScodes As Integer
Count of permitted return values.
ElemDescFunc As ELEMDESC
Contains the return type of the function.
wFuncFlags As Integer
Definition of flags follows.
TYPEATTR
typeguid As CLSID
The GUID of the type information.
typelcid As Long
Locale of member names and doc strings.
dwReserved As Long
Reserved.
memidConstructor As Long
ID of constructor, or MEMBERID_NIL if none.
memidDestructor As Long
ID of destructor, or MEMBERID_NIL if none.
lpstrSchema As Long
Reserved for future use
cbSizeInstance As Long
The size of an instance of this type.
TYPEKIND As TYPEKIND
The kind of type this information describes.
cFuncs As Integer
Number of functions.
cVars As Integer
Number of variables/data members.
cImplTypes As Integer
Number of implemented interfaces.
cbSizeVft As Integer
The size of this type's VTBL.
cbAlignment As Integer
Byte alignment for an instance of this type.
wTypeFlags As Integer
Type Flags.
wMajorVerNum As Integer
Major version number.
wMinorVerNum As Integer
Minor version number.
tdescAlias As TYPEDESC
If TypeKind == TKIND_ALIAS, specifies the type for which this type is an alias.
idldescType As IDLDESC
IDL attributes of the described type.
VARDESC
Describes a variable, constant, or data member.
MemID As Long
lpstrSchema As Long
Reserved for future use.
lpVarValue As Long
ElemDescVar As ELEMDESC
Contains the variable type
wVarFlags As Integer
Definition of flags follows
VARKIND As VARKIND
Functions
GetTypeAttr
Retrieves a TYPEATTR structure that contains the attributes of the type description. Function GetTypeAttr (ByRef pTypeAttr As Long) As Long
GetTypeComp
Retrieves the ITypeComp interface for the type description, which enables a client compiler to bind to the type description's members. Function GetTypeComp (ByRef ppTComp As Long) As Long
GetFuncDesc
Retrieves the FUNCDESC structure that contains information about a specified function. Function GetFuncDesc (ByVal index As Long, ByRef pFuncDesc As Long) As Long
GetVarDesc
Retrieves a VARDESC structure that describes the specified variable. Function GetVarDesc (ByVal index As Long, ByRef pVarDesc As Long) As Long
GetNames
Retrieves the variable with the specified member ID (or the name of the property or method and its parameters) that correspond to the specified function ID. Function GetNames (ByVal MemID As Long, ByRef rgbstrNames As String, ByVal cMaxNames As Long, ByRef pcNames As Long) As Long
GetRefTypeOfImplType
If a type description describes a COM class, it retrieves the type description of the implemented interface types. For an interface, GetRefTypeOfImplType returns the type information for inherited interfaces, if any exist. Function GetRefTypeOfImplType (ByVal index As Long, ByRef hpreftype As Long) As Long
GetImplTypeFlags
If a type description describes a COM class, it retrieves the type description of the implemented interface types. For an interface, GetRefTypeOfImplType returns the type information for inherited interfaces, if any exist. Function GetImplTypeFlags (ByVal index As Long, ByRef pimpltypeflags As Long) As Long
GetIDsOfNames
Maps between member names and member IDs, and parameter names and parameter IDs. Function GetIDsOfNames (ByRef rglpszNames As Integer, ByVal cNames As Long, ByRef rgMemId As Long) As Long
Invoke
Invokes a method, or accesses a property of an object, that implements the interface described by the type description. Function Invoke (ByRef pvInstance As Any, ByVal MemID As Long, ByVal wFlags As Integer, ByRef pdispparams As DISPPARAMS, ByRef pvarResult As Variant, ByRef pexcepinfo As EXCEPINFO, ByRef puArgErr As Long) As Long
GetDocumentation
Retrieves the documentation string, the complete Help file name and path, and the context ID for the Help topic for a specified type description. Function GetDocumentation (ByVal MemID As Long, ByRef pBstrName As String, ByRef pBstrDocString As String, ByRef pdwHelpContext As Long, ByRef pBstrHelpFile As String) As Long
GetDllEntry
Retrieves a description or specification of an entry point for a function in a DLL. Function GetDllEntry (ByVal MemID As Long, ByRef InvKind As INVOKEKIND, ByRef pbstrDllName As String, ByRef pBstrName As String, ByRef pwOrdinal As Integer) As Long
GetRefTypeInfo
If a type description references other type descriptions, it retrieves the referenced type descriptions. Function GetRefTypeInfo (ByVal hreftype As Long, ByRef pptinfo As ITypeInfo) As Long
AddressOfMember
Retrieves the addresses of static functions or variables, such as those defined in a DLL. Function AddressOfMember (ByVal MemID As Long, ByRef InvKind As INVOKEKIND, ByRef ppv As Any) As Long
CreateInstance
Creates a new instance of a type that describes a component object class (coclass). Function CreateInstance (ByVal puncOuter As IUnknown, ByRef riid As CLSID, ByRef ppvObj As Any) As Long
GetMops
Retrieves marshaling information. Function GetMops (ByVal MemID As Long, ByRef pbstrMops As String) As Long
GetContainingTypeLib
Retrieves the containing type library and the index of the type description within that type library. Function GetContainingTypeLib (ByRef pptlib As ITypeLib, ByRef pindex As Long) As Long
ReleaseTypeAttr
Releases a TYPEATTR previously returned by GetTypeAttr. Function ReleaseTypeAttr (ByVal pTypeAttr As Long) As Any
ReleaseFuncDesc
Releases a FUNCDESC previously returned by GetFuncDesc. Function ReleaseFuncDesc (ByVal pFuncDesc As Long) As Any
ReleaseVarDesc
Releases a VARDESC previously returned by GetVarDesc. Function ReleaseVarDesc (ByVal pVarDesc As Long) As Any
Interface IOleWindow
IOleWindow Interface. The IOleWindow interface provides methods that allow an application to obtain the handle to the various windows that participate in in-place activation, and also to enter and exit context-sensitive help mode.
Functions
GetWindow
Returns the window handle to one of the windows participating in in-place activation (frame, document, parent, or in-place object window). Function GetWindow (ByRef phwnd As Long) As Long
ContextSensitiveHelp
Determines whether context-sensitive help mode should be entered during an in-place activation session. Function ContextSensitiveHelp (ByVal fEnterMode As Long) As Long
Interface IOleInPlaceObject
IOleInPlaceObject Interface
Functions
InPlaceDeactivate
Deactivates an active in-place object and discards the object's undo state. Function InPlaceDeactivate () As Long
UIDeactivate
Deactivates and removes the user interface that supports in-place activation. Function UIDeactivate () As Long
SetObjectRects
Indicates how much of the in-place object is visible. Function SetObjectRects (ByRef lprcPosRect As RECT, ByRef lprcClipRect As RECT) As Long
ReactivateAndUndo
Reactivates a previously deactivated object, undoing the last state of the object. Function ReactivateAndUndo () As Long
Interface IOleInPlaceActiveObject
IOleInPlaceActiveObject Interface
Functions
TranslateAccelerator
Translates messages. Function TranslateAccelerator (ByRef lpMsg As MSG) As Long
OnFrameWindowActivate
State of container's top-level frame. Function OnFrameWindowActivate (ByVal fActivate As Long) As Long
OnDocWindowActivate
State of container document window. Function OnDocWindowActivate (ByVal fActivate As Long) As Long
ResizeBorder
Alert object of need to resize border space. Function ResizeBorder (ByRef prcBorder As RECT, ByRef pUIWindow As IOleInPlaceUIWindow, ByVal fFrameWindow As Long) As Long
EnableModeless
Enable or disable modeless dialog boxes. Function EnableModeless (ByVal fEnable As Long) As Long
Interface IOleInPlaceObjectWindowless
IOleInPlaceObjectWindowless.
Functions
OnWindowMessage
Dispatches a message from a container to a windowless object that is in-place active. Function OnWindowMessage (ByVal MSG As Long, ByVal wParam As Long, ByVal lParam As Long, ByRef plResult As Long) As Long
GetDropTarget
Supplies the IDropTarget interface for an in-place active, windowless object that supports drag and drop. Function GetDropTarget (ByRef ppDropTarget As IDropTarget) As Long
Interface IOleInPlaceUIWindow
IOleInPlaceUIWindow Interface. The IOleInPlaceUIWindow interface is implemented by container applications and used by object applications to negotiate border space on the document or frame window.
Functions
GetBorder
Returns a RECT structure in which the object can put toolbars and similar controls while active in place. Function GetBorder (ByVal lprectBorder As Long) As Long
RequestBorderSpace
Determines if there is available space for tools to be installed around the object's window frame while the object is active in place. Function RequestBorderSpace (ByVal pBorderWidths As Long) As Long
SetBorderSpace
Allocates space for the border requested in the call to IOleInPlaceUIWindow::RequestBorderSpace. Function SetBorderSpace (ByVal pBorderWidths As Long) As Long
SetActiveObject
Provides a direct channel of communication between the object and each of the frame and document windows. Function SetActiveObject (ByRef pActiveObject As IOleInPlaceActiveObject, ByVal pszObjName As String) As Long
Interface IOleInPlaceFrame
IOleInPlaceFrame Interface
Functions
EnableModeless
Enables or disables a frame's modeless dialog boxes. Function EnableModeless (ByVal fEnable As Long) As Long
InsertMenus
Allows the container to insert its menu groups into the composite menu to be used during the in-place session. Function InsertMenus (ByVal hMenuShared As Long, ByVal lpMenuWidths As Long) As Long
RemoveMenus
Gives the container a chance to remove its menu elements from the in-place composite menu. Function RemoveMenus (ByVal hMenuShared As Long) As Long
SetMenu
Installs the composite menu in the window frame containing the object being activated in place. Function SetMenu (ByVal hMenuShared As Long, ByVal hOleMenu As Long, ByVal hWndActiveObject As Long) As Long
SetStatusText
Sets and displays status text about the in-place object in the container's frame window status line. Function SetStatusText (ByVal pszStatusText As String) As Long
TranslateAccelerator
Translates accelerator keystrokes intended for the container's frame while an object is active in place. Function TranslateAccelerator (ByRef lpMsg As MSG, ByVal wID As Integer) As Long
Interface IOleInPlaceSite
IOleInPlaceSite Interface. The IOleInPlaceSite interface manages interaction between the container and the object's in-place client site
Functions
CanInPlaceActivate
Determines whether or not the container can activate the object in place. Function CanInPlaceActivate () As Long
DeactivateAndUndo
Causes the container to end the in-place session, deactivate the object, and revert to its own saved undo state. Function DeactivateAndUndo () As Long
DiscardUndoState
Tells the container that the object no longer has any undo state and that the container should not call IOleInPlaceObject::ReActivateAndUndo. Function DiscardUndoState () As Long
GetWindowContext
Enables the in-place object to retrieve the window interfaces that form the window object hierarchy, and the position in the parent window where the object's in-place activation window should be placed. Function GetWindowContext (ByRef ppFrame As IOleInPlaceFrame, ByRef ppDoc As IOleInPlaceUIWindow, ByRef lprcPosRect As RECT, ByRef lprcClipRect As RECT, ByRef lpFrameInfo As OLEINPLACEFRAMEINFO) As Long
OnInPlaceActivate
Notifies the container that one of its objects is being activated in place. Function OnInPlaceActivate () As Long
OnInPlaceDeactivate
Notifies the container that the object is no longer active in place. Function OnInPlaceDeactivate () As Long
OnPosRectChange
Indicates the object's extents have changed. Function OnPosRectChange (ByRef lprcPosRect As RECT) As Long
OnUIActivate
Notifies the container that the object is about to be activated in place and that the object is going to replace the container's main menu with an in-place composite menu. Function OnUIActivate () As Long
OnUIDeactivate
Notifies the container on deactivation that it should reinstall its user interface and take focus, and whether or not the object has an undoable state. Function OnUIDeactivate (ByVal fUndoable As Long) As Long
Scroll
IOleInPlaceSite::Scroll Function Scroll (ByVal lpScrollExtant As Long) As Long
Interface IOleInPlaceSiteEx
IOleInPlaceSiteEx Interface. The IOleInPlaceSiteEx interface provides an additional set of activation and deactivation notification methods that enable an object to avoid unnecessary flashing on the screen when the object is activated and deactivated.
Functions
OnInPlaceActivateEx
Called by the embedded object to determine if it needs to redraw itself upon activation. Function OnInPlaceActivateEx (ByRef pfNoRedraw As Long, ByVal dwFlags As Long) As Long
OnInPlaceDeactivateEx
Notifies the container if the object needs to be redrawn upon deactivation. Function OnInPlaceDeactivateEx (ByVal fNoRedraw As Long) As Long
RequestUIActivate
Notifies the container that the object is about to enter the UI-active state. Function RequestUIActivate () As Long
Interface IOleInPlaceSiteWindowless
IOleInPlaceSiteWindowless Interface. IOleInPlaceSiteWindowless works with IOleInPlaceObjectWindowless which is implemented on the windowless object. Together, these two interfaces provide services to a windowless object from its container.
Functions
CanWindowlessActivate
Informs an object if its container can support it as a windowless object that can be in-place activated. Function CanWindowlessActivate () As Long
GetCapture
Called by an in-place active, windowless object to determine if it still has the mouse capture or not. Function GetCapture () As Long
SetCapture
Enables an in-place active, windowless object to capture all mouse messages. Function SetCapture (ByVal fCapture As Long) As Long
GetFocus
Called by an in-place active, windowless object to determine if it still has the keyboard focus or not. Function GetFocus () As Long
SetFocus
Sets the keyboard focus for a UI-active, windowless object. Function SetFocus (ByVal fFocus As Long) As Long
GetDC
Provides an object with a handle to a device context for a screen or compatible device from its container. Function GetDC (ByRef pRect As RECT, ByVal grfFlags As Long, ByRef phDC As Long) As Long
ReleaseDC
Releases the device context previously obtained by a call to IOleInPlaceSiteWindowless.GetDC. Function ReleaseDC (ByVal hDC As Long) As Long
InvalidateRect
Enables an object to invalidate a specified rectangle of its in-place image on the screen. Function InvalidateRect (ByRef pRect As RECT, ByVal fErase As Long) As Long
InvalidateRgn
Enables an object to invalidate a specified region of its in-place image on the screen. Function InvalidateRgn (ByVal hRGN As Long, ByVal fErase As Long) As Long
ScrollRect
Enables an object to scroll an area within its in-place active image on the screen. Function ScrollRect (ByVal dx As Long, ByVal dy As Long, ByRef pRectScroll As RECT, ByRef pRectClip As RECT) As Long
AdjustRect
Adjusts a specified rectangle if it is entirely or partially covered by overlapping, opaque objects. Function AdjustRect (ByRef prc As RECT) As Long
OnDefWindowMessage
Adjusts a specified rectangle if it is entirely or partially covered by overlapping, opaque objects. Function OnDefWindowMessage (ByVal MSG As Long, ByVal wParam As Long, ByVal lParam As Long, ByRef plResult As Long) As Long
Interface IOleObject
IOleObject Interface. The IOleObject interface is the principal means by which an embedded object provides basic functionality to, and communicates with, its container.
Enums
OLEMISC
The OLEMISC enumeration is a set of bitwise constants that can be combined to describe miscellaneous characteristics of an object or class of objects.
OLEMISC_RECOMPOSEONRESIZE = &H1
When the container resizes the space allocated to displaying one of the object's presentations, the object wants to recompose the presentation. This means that on resize, the object wants to do more than scale its picture.
OLEMISC_ONLYICONIC = &H2
The object has no useful content view other than its icon. From the user's perspective, the Display As Icon check box (in the Paste Special dialog box) for this object should always be checked, and should not be uncheckable.
OLEMISC_INSERTNOTREPLACE = &H4
The object has initialized itself from the data in the container's current selection. Containers should examine this bit after calling IOleObject::InitFromData to initialize an object from the current selection.
OLEMISC_STATIC = &H8
This object is a static object, which is an object that contains only a presentation; it contains no native data. See OleCreateStaticFromData.
OLEMISC_CANTLINKINSIDE = &H10
This object cannot be the link source that when bound to activates (runs) the object.
OLEMISC_CANLINKBYOLE1 = &H20
This object can be linked to by OLE 1 containers. This bit is used in the dwStatus member of the OBJECTDESCRIPTOR structure transferred with the Object and Link Source Descriptor formats.
OLEMISC_ISLINKOBJECT = &H40
This object is a link object. This bit is significant to OLE 1 and is set by the OLE 2 link object; object applications have no need to set this bit.
OLEMISC_INSIDEOUT = &H80
This object is capable of activating in-place, without requiring installation of menus and toolbars to run. Several such objects can be active concurrently. Some containers, such as forms, may choose to activate such objects automatically.
OLEMISC_ACTIVATEWHENVISIBLE = &H100
This bit is set only when OLEMISC_INSIDEOUT is set, and indicates that this object prefers to be activated whenever it is visible. Some containers may always ignore this hint.
OLEMISC_RENDERINGISDEVICEINDEPENDENT = &H200
This object does not pay any attention to target devices. Its presention data will be the same in all cases.
OLEMISC_INVISIBLEATRUNTIME = &H400
This value is used with controls. It indicates that the control has no run-time user interface, but that it should be visible at design time.
OLEMISC_ALWAYSRUN = &H800
This value is used with controls. It tells the container that this control always wants to be running.
OLEMISC_ACTSLIKEBUTTON = &H1000
This value is used with controls. It indicates that the control is buttonlike in that it understands and obeys the container's DisplayAsDefault ambient property.
OLEMISC_ACTSLIKELABEL = &H2000
This value is used with controls. It marks the control as a label for whatever control comes after it in the form's ordering. Pressing a mnemonic key for a label control activates the control after it.
OLEMISC_NOUIACTIVATE = &H4000
This value is used with controls. It indicates that the control has no UI active state, meaning that it requires no in-place tools, no shared menu, and no accelerators. It also means that the control never needs the focus.
OLEMISC_ALIGNABLE = &H8000
This value is used with controls. It indicates that the control understands how to align itself within its display rectangle, according to alignment properties such as left, center, and right.
OLEMISC_SIMPLEFRAME = &H10000
This value is used with controls. It indicates that the control is a simple grouping of other controls and does little more than pass Windows messages to the control container managing the form.
OLEMISC_SETCLIENTSITEFIRST = &H20000
This value is used with controls. It indicates that the control wants to use IOleObject::SetClientSite as its initialization function, even before a call such as IPersistStreamInit::InitNew or IPersistStorage::InitNew.
OLEMISC_IMEMODE = &H40000
Obsolete. A control that works with an Input Method Editor (IME) system component can control the state of the IME through the IMEMode property rather than using this value in the OLEMISC enumeration.
OLEMISC_IGNOREACTIVATEWHENVISIBLE = &H80000
For new ActiveX controls to work in an older container, the control may need to have the OLEMISC_ACTIVATEWHENVISIBLE value set.
OLEMISC_WANTSTOMENUMERGE = &H100000
A control that can merge its menu with its container sets this value.
OLEMISC_SUPPORTSMULTILEVELUNDO = &H200000
A control that supports multi-level undo sets this value.
OLECLOSE
The OLECLOSE enumeration constants are used in the IOleObject.Close method to determine whether the object should be saved before closing.
OLECLOSE_SAVEIFDIRTY = &H0
The object should be saved if it is dirty.
OLECLOSE_NOSAVE = &H1
The object should not be saved, even if it is dirty.
OLECLOSE_PROMPTSAVE = &H2
If the object is dirty, the IOleObject::Close implementation should display a dialog box to let the end user determine whether to save the object.
OLEGETMONIKER
The OLEGETMONIKER enumeration constants indicate the requested behavior of the IOleObject.GetMoniker and IOleClientSite.GetMoniker methods.
OLEGETMONIKER_ONLYIFTHERE = &H1
If a moniker for the object or container does not exist, GetMoniker should return E_FAIL and not assign a moniker
OLEGETMONIKER_FORCEASSIGN = &H2
If a moniker for the object or container does not exist, GetMoniker should create one.
OLEGETMONIKER_UNASSIGN = &H3
IOleClientSite::GetMoniker can release the object's moniker (although it is not required to do so). This constant is not valid in IOleObject::GetMoniker.
OLEGETMONIKER_TEMPFORUSER = &H4
If a moniker for the object does not exist, IOleObject::GetMoniker can create a temporary moniker that can be used for display purposes (IMoniker::GetDisplayName) but not for binding.
Functions
SetClientSite
Informs an embedded object of its display location, called a 'client site', within its container. Function SetClientSite (ByRef pClientSite As IOleClientSite) As Long
GetClientSite
Obtains a pointer to an embedded object's client site. Function GetClientSite (ByRef ppClientSite As IOleClientSite) As Long
SetHostNames
Provides an object with the name of its container application and the compound document in which it is embedded. Function SetHostNames (ByVal szContainerApp As String, ByVal szContainerObj As String) As Long
Close
Changes an embedded object from the running to the loaded state. Disconnects a linked object from its link source. Function Close (ByVal dwSaveOption As Long) As Long
SetMoniker
Notifies an object of its container's moniker, the object's own moniker relative to the container, or the object's full moniker. Function SetMoniker (ByVal dwWhichMoniker As Long, ByRef pmk As Long) As Long
GetMoniker
Retrieves an embedded object's moniker, which the caller can use to link to the object. Function GetMoniker (ByVal dwAssign As Long, ByVal dwWhichMoniker As Long, ByRef ppmk As Long) As Long
InitFromData
Initializes a newly created object with data from a specified data object, which can reside either in the same container or on the Clipboard. Function InitFromData (ByRef pDataObject As Long, ByVal fCreation As Long, ByVal dwReserved As Long) As Long
GetClipboardData
Retrieves a data object containing the current contents of the embedded object on which this method is called. Using the pointer to this data object, it is possible to create a new embedded object with the same data as the original. Function GetClipboardData (ByVal dwReserved As Long, ByRef ppDataObject As Long) As Long
DoVerb
Requests an object to perform an action in response to an end-user's action. The possible actions are enumerated for the object in IOleObject::EnumVerbs. Function DoVerb (ByVal iVerb As Long, ByRef lpMsg As MSG, ByRef pActiveSite As IOleClientSite, ByVal lindex As Long, ByVal hWndParent As Long, ByRef lprcPosRect As RECT) As Long
EnumVerbs
Exposes a pull-down menu listing the verbs available for an object in ascending order by verb number. Function EnumVerbs (ByRef ppEnumOleVerb As IEnumOLEVERB) As Long
Update
Updates an object handler's or link object's data or view caches. Function Update () As Long
IsUpToDate
Checks recursively whether or not an object is up to date. Function IsUpToDate () As Long
GetUserClassID
Returns an object's class identifier, the CLSID corresponding to the string identifying the object to an end user. Function GetUserClassID (ByRef pClsid As CLSID) As Long
GetUserType
Retrieves the user-type name of an object for display in user-interface elements such as menus, list boxes, and dialog boxes. Function GetUserType (ByVal dwFormOfType As Long, ByRef pszUserType As String) As Long
SetExtent
Informs an object of how much display space its container has assigned it. Function SetExtent (ByVal dwDrawAspect As Long, ByRef pSize As SIZE) As Long
GetExtent
Retrieves a running object's current display size. Function GetExtent (ByVal dwDrawAspect As Long, ByVal lpSize As Long) As Long
Advise
Establishes an advisory connection between a compound document object and the calling object's advise sink, through which the calling object receives notification when the compound document object is renamed, saved, or closed. Function Advise (ByRef pAdvSink As Long, ByRef pdwConnection As Long) As Long
Unadvise
Deletes a previously established advisory connection. Function Unadvise (ByVal dwConnection As Long) As Long
EnumAdvise
Retrieves a pointer to an enumerator that can be used to enumerate the advisory connections registered for an object, so a container can know what to release prior to closing down. Function EnumAdvise (ByRef ppenumAdvise As Long) As Long
GetMiscStatus
Returns a value indicating the status of an object at creation and loading. Function GetMiscStatus (ByVal dwAspect As Long, ByRef pdwStatus As Long) As Long
SetColorScheme
Specifies the color palette that the object application should use when it edits the specified object. Function SetColorScheme (ByVal pLogPal As Long) As Long
Interface IOleClientSite
IOleClientSite Interface. The IOleClientSite interface is the primary means by which an embedded object obtains information about the location and extent of its display site, its moniker, its user interface, and other resources provided by its container.
Functions
SaveObject
Saves the object associated with the client site. This function is synchronous; by the time it returns, the save will be completed. Function SaveObject () As Long
GetMoniker
Returns a moniker to an object's client site. An object can force the assignment of its own or its container's moniker by specifying a value for dwAssign. Function GetMoniker (ByVal dwAssign As Long, ByVal dwWhichMoniker As Long, ByRef ppmk As Long) As Long
GetContainer
Returns a pointer to the container's IOleContainer interface. Function GetContainer (ByRef ppContainer As Long) As Long
ShowObject
Tells the container to position the object so it is visible to the user. This method ensures that the container itself is visible and not minimized. Function ShowObject () As Long
OnShowWindow
Notifies a container when an embedded object's window is about to become visible or invisible. This method does not apply to an object that is activated in place and therefore has no window separate from that of its container. Function OnShowWindow (ByVal fShow As Long) As Long
RequestNewObjectLayout
Asks container to allocate more or less space for displaying an embedded object. Function RequestNewObjectLayout () As Long
Interface IOleControl
IOleInPlaceSite Interface. The IOleControl interface provides the features for supporting keyboard mnemonics (GetControlInfo, OnMnemonic), ambient properties (OnAmbientPropertyChange), and events (FreezeEvents) in control objects.
Types
CONTROLINFO
cb As Long
haccel As Long
cAccel As Integer
dwFlags As Long
Functions
GetControlInfo
Fills in a CONTROLINFO structure with information about a control's keyboard mnemonics and keyboard behavior. Function GetControlInfo (ByRef pCI As CONTROLINFO) As Long
OnMnemonic
Informs a control that the user has pressed a keystroke that matches one of the ACCEL entries in the mnemonic table returned through IOleControl::GetControlInfo. The control takes whatever action is appropriate for the keystroke. Function OnMnemonic (ByRef pMsg As MSG) As Long
OnAmbientPropertyChange
Informs a control that one or more of the container's ambient properties (available through the control site's IDispatch) has changed. Function OnAmbientPropertyChange (ByVal dispID As Long) As Long
FreezeEvents
Indicates whether the container is ignoring or accepting events from the control. Function FreezeEvents (ByVal bFreeze As Long) As Long
Interface IPropertyPage
IPropertyPage interface. The IPropertyPage interface provides the main features of a property page object that manages a particular page within a property sheet.
Types
PROPPAGEINFO
The PROPPAGEINFO structure contains parameters used to describe a property page to a property frame. A property page fills a caller-provided structure in the IPropertyPage::GetPageInfo method
cb As Long
Size of the PROPPAGEINFO structure
pszTitle As Long
Pointer to the string that appears in the tab for this page
SIZE As SIZE
Required dimensions of the page's dialog box, in pixels
pszDocString As Long
Pointer to a text string describing the pagePointer to a text string describing the page
pszHelpFile As Long
Pointer to the simple name of the help file that describes this property page
dwHelpContext As Long
Context identifier for the help topic within pszHelpFile that describes this page
Functions
SetPageSite
Initializes a property page and provides the property page object with the IPropertyPageSite interface through which the property page communicates with the property frame. Function SetPageSite (ByRef pPageSite As IPropertyPageSite) As Long
Activate
Creates the dialog box for the property page (without a frame, caption, or system menu/controls) using hWndParent as the parent window and prc as the positioning rectangle. Function Activate (ByVal hWndParent As Long, ByRef pRect As RECT, ByVal bModal As Long) As Long
Deactivate
Destroys the window created in IPropertyPage.Activate. Function Deactivate () As Long
GetPageInfo
Fills a caller-allocated PROPPAGEINFO structure to provide the caller with information about the property page. Function GetPageInfo (ByRef pPageInfo As PROPPAGEINFO) As Long
SetObjects
Provides the IUnknown pointers of the objects affected by the property sheet in which this property page is displayed. Function SetObjects (ByVal cObjects As Long, ByRef lppUnk As Long) As Long
Show
Makes the property page dialog box visible or invisible according to the nCmdShow parameter. Function Show (ByVal nCmdShow As Long) As Long
Move
Repositions and resizes the property page dialog box according to the contents of prc. Function Move (ByRef pRect As RECT) As Long
IsPageDirty
Repositions and resizes the property page dialog box according to the contents of prc. Function IsPageDirty () As Long
Apply
Applies the current values to the underlying objects associated with the property page as previously passed to IPropertyPage.SetObjects. Function Apply () As Long
Help
Invokes the property page help in response to an end-user request. Function Help (ByVal pszHelpDir As Long) As Long
TranslateAccelerator
Repositions and resizes the property page dialog box according to the contents of prc. Function TranslateAccelerator (ByRef pMsg As MSG) As Long
Interface IPropertyPageSite
IPropertyPageSite interface. The IPropertyPageSite interface provides the main features for a property page site object.
Functions
OnStatusChange
Informs the frame that the property page managed by this site has changed its state, that is, one or more property values have been changed in the page. Function OnStatusChange (ByVal dwFlags As Long) As Long
GetLocaleID
Returns the locale identifier (an LCID) that a property page can use to adjust itself to the language in use and other country-specific or region-specific settings. Function GetLocaleID (ByRef pLocaleID As Long) As Long
GetPageContainer
Returns an IUnknown pointer to the object representing the entire property frame dialog box that contains all the pages. Calling this method could potentially allow one page to navigate to another. Function GetPageContainer (ByRef ppunk As IUnknown) As Long
TranslateAccelerator
Instructs the page site to process a keystroke if it desires. Function TranslateAccelerator (ByRef pMsg As MSG) As Long
Interface IPerPropertyBrowsing
IPerPropertyBrowsing Interface
Functions
GetDisplayString
Returns a text string describing the specified property. Function GetDisplayString (ByVal dispID As Long, ByRef DisplayName As String) As Long
MapPropertyToPage
Returns the CLSID of the property page that allows manipulation of the specified property. Function MapPropertyToPage (ByVal dispID As Long, ByRef pClsid As CLSID) As Long
GetPredefinedStrings
Returns a counted array of strings (LPOLESTR pointers) listing the descriptions of the allowable values that the specified property can accept (i.e., the values returned from IPerPropertyBrowsing::GetPredefinedValue. Function GetPredefinedStrings (ByVal dispID As Long, ByRef pCaStringsOut As CALPOLESTR, ByRef pCaCookiesOut As CADWORD) As Long
GetPredefinedValue
Returns a VARIANT containing the value of a property identified with dispID that is associated with a predefined string name as returned from IPerPropertyBrowsing::GetPredefinedStrings. Function GetPredefinedValue (ByVal dispID As Long, ByVal dwCookie As Long, ByRef pVarOut As Variant) As Long