_OpenComponent Struct Reference

#include <compmgr.h>

List of all members.

---

Detailed Description

Default component interface.

Each component must provide implementation of the functions from this interface.

Public Attributes
const char *(*	GetName )()
	Returns a component name.
const char *(*	GetVersion )()
	Returns a component version which is numbers separated with dots.
const char *(*	GetDescription )()
	Returns human-readable description of the component.
const char *(*	GetVendor )()
	Returns the human-readable vendor string, e.
const char *(*	GetProperty )(const char *key)
	Queries optional properties.
const char **(*	ListInterfaceNames )()
	Exposes a NULL terminated list of component-specific interface names for the given component.
int(*	GetInterface )(OpenInterfaceHandle *p_intf, const char *intf_name)
	Exposes a component interface.
int(*	Free )()
	The call to this function frees all component resources.

---

Member Data Documentation

const char*(* _OpenComponent.GetName)()

Returns a component name.

const char*(* _OpenComponent.GetVersion)()

Returns a component version which is numbers separated with dots.

Implementors must check a major version number for compatibility.

const char*(* _OpenComponent.GetDescription)()

Returns human-readable description of the component.

const char*(* _OpenComponent.GetVendor)()

Returns the human-readable vendor string, e.

 g., name of the organization which provides this component.

const char*(* _OpenComponent.GetProperty)(const char *key)

Queries optional properties.

Parameters:

key

property name

Returns:

a string, true/false for boolean properties

const char**(* _OpenComponent.ListInterfaceNames)()

Exposes a NULL terminated list of component-specific interface names for the given component.

This default component interface is not included.

Returns:

a pointer to an internal component manager structure, which should not be modified or freed.

int(* _OpenComponent.GetInterface)(OpenInterfaceHandle *p_intf, const char *intf_name)

Exposes a component interface.

Parameters:

[out]	p_intf	on return, points to an interface handle
	intf_name	an interface name

Returns:

APR_SUCCESS if successful, otherwise a non-zero error code

int(* _OpenComponent.Free)()

The call to this function frees all component resources.

Returns:

APR_SUCCESS if successful, otherwise a non-zero error code

---

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

• compmgr.h

---