This documentation is archived and is not being maintained.

GetExtender Method (IExtenderProvider Interface)

Visual Studio .NET 2003

Returns an Extender for the given object under the specified category.

[Visual Basic .NET]
Public Function GetExtender( _
   ByVal ExtenderCATID As String, _
   ByVal ExtenderName As String, _
   ByVal ExtendeeObject As Object, _
   ByVal ExtenderSite As IExtenderSite, _
   ByVal Cookie As Int _
) As Object
[Visual Basic 6]
Function GetExtender( _
   ByVal ExtenderCATID As String, _
   ByVal ExtenderName As String, _
   ByVal ExtendeeObject As Object, _
   ByVal ExtenderSite As IExtenderSite, _
   ByVal Cookie As Int _
) As Object
[C++]
HRESULT __stdcall GetExtender(
   BSTR ExtenderCATID,
   BSTR ExtenderName,
   IDispatch* ExtendeeObject,
   IExtenderSite* ExtenderSite,
   int Cookie,
   /* [out, retval] */ IDispatch** retVal
);
[C#]
object GetExtender(
   string ExtenderCATID,
   string ExtenderName,
   object ExtendeeObject,
   IExtenderSite ExtenderSite,
   int Cookie
);
[JScript .NET]
public function GetExtender(
   ExtenderCATID : String,
   ExtenderName : String,
   ExtendeeObject : Object,
   ExtenderSite : IExtenderSite,
   Cookie : int
) : Object

Parameters

ExtenderCATID
The CATID for the Extender being requested.
ExtenderName
The name for the Extender being requested.
ExtendeeObject
The Extendee object.
ExtenderSite
The Extender site, represented by an IExtenderSite interface.
Cookie
The cookie identifying the Extender.

Remarks

GetExtender returns the Extender for the given CATID and name for the specified Extendee instance. This method is called only if CanExtend returns True.

The Extender Provider must cache the passed ExtenderSite object and Cookie. When the Extender is being destroyed, it must call NotifyDelete on the site passing the cookie back.

See Also

Implementing and Using Automation Extenders

Applies To: IExtenderProvider Interface

Show: