GetInterface Method (IBodyPart)
Topic Last Modified: 2006-06-13
Returns the specified dual interface on the object.
Applies To
Type Library
Microsoft CDO for Exchange 2000 Library
DLL Implemented In
CDOEX.DLL
Syntax
Function GetInterface( ByVal Interface As String) As Object
HRESULT GetInterface
(
BSTR Interface,
IDispatch** pVal
);
Parameters
- Interface
The name of the interface. The list of possible interfaces to return depends upon the Component Object Model (COM) class that provides the implementation.
- pVal
Returned reference to the objects IDispatch Interface.
Return Value
Returns S_OK if successful, or an error value otherwise.
Remarks
The GetInterface method is primarily intended as a generic interface navigation aid to scripting languages that do not support such navigation directly. Most COM classes that provide implementations of the IMessage interface expose additional dual interfaces that are accessible by scripting languages only through properties on the interface, such as BodyPart and DataSource, or through using the GetInterface method. When properties do not exist on the interface to return these interfaces, the GetInterface method must be used.
The list of valid interface names to pass to GetInterface is dependent upon a specific implementation. As a general rule, the name of the desired interface should match the physical name of the interface as it appears in the type library or .idl file. Check the appropriate COM class for a list of exposed dual interfaces. If the object does not support the requested interface, an exception is raised with the HRESULT value of E_INVALIDARG.
Examples
The following example is in Microsoft® Visual Basic® Scripting Edition (VBScript):
' Assume iBodyPart contains a valid IBodyPart interface reference.
Dim iMessage
Set iMessage = iBodyPart.GetInterface("IMessage")
...
The following example is in Microsoft JScript®:
' Assume iBodyPart contains a valid IBodyPart interface reference.
var iMsg
iMsg = iBodyPart.GetInterface("IMessage");
...