IPluginCollection Struct Reference

Universal Document Shell Plugin Collection interface. Through IPluginCollection, caller can access the elements of data collection returned by plugin. More...

#include <plugin_collection.h>

Inheritance diagram for IPluginCollection:

[legend]

Data Fields
PluginStatus(*	get_data )(IPluginUnknown *thiz, void **data_ptr)
	Retrieve start address of the collection data.
int(*	get_num_elements )(IPluginUnknown *thiz)
	Retrieve the number of elements.

---

Detailed Description

Universal Document Shell Plugin Collection interface. Through IPluginCollection, caller can access the elements of data collection returned by plugin.

Copyright (C) 2008 iRex Technologies B.V. All rights reserved.

Definition at line 42 of file plugin_collection.h.

---

Field Documentation

PluginStatus(* IPluginCollection::get_data)(IPluginUnknown *thiz, void **data_ptr)

Retrieve start address of the collection data.

Parameters:

	thiz	IPluginUnknown pointer of collection object.
	data_ptr	The output variable that contains the start address of the collection data.

Returns:

TODO. Add return code here.

Referenced by text::PluginCollectionImpl::PluginCollectionImpl(), pdf::PluginCollectionImpl::PluginCollectionImpl(), and images::PluginCollectionImpl::PluginCollectionImpl().

int(* IPluginCollection::get_num_elements)(IPluginUnknown *thiz)

Retrieve the number of elements.

Parameters:

thiz

IPluginUnknown pointer of collection object .

Returns:

This function returns the number of elements in the collection.

Referenced by text::PluginCollectionImpl::PluginCollectionImpl(), pdf::PluginCollectionImpl::PluginCollectionImpl(), and images::PluginCollectionImpl::PluginCollectionImpl().

---

The documentation for this struct was generated from the following file:

• plugin_collection.h