source/core/inc/mh5object.h File Reference

Implement functions to retrieve MHEG5objects by GroupID and ID. More...

#include "mh5root.h"

Go to the source code of this file.

Functions
MHEG5String	MHEG5getGroupId (MHEG5Root *root)
	<Function description>="">
MHEG5Root *	MHEG5findObject (MH5GroupRef gid, MHEG5Int id)
MHEG5Root *	MHEG5resolveRealObject (MHEG5Root *objref)
MHEG5GList *	MHEG5resolveORef (MHEG5GList *params, MHEG5Root **object)
MHEG5GList *	MHEG5resolveGenericORefProper (MHEG5GList *params, MH5GroupRef *pgroupRef, MHEG5Int *id)
	Resolve a generic object reference, returning the object reference. The reference can be direct or indirect. This function is similar to MHEG5resolveGenericORef, except that the object reference itself is returned (groupId + Id), rather than the object that it points to.
MHEG5GList *	MHEG5resolveGenericORef (MHEG5GList *params, MHEG5Root **object)
MHEG5GList *	MHEG5resolveGenericCRef (MHEG5GList *params, MHEG5String *data, MHEG5Bool *referenced, MHEG5Bool *valid)
MHEG5GList *	MHEG5resolveGenericGeneric (MHEG5GList *params, MHEG5Generic *value)
MHEG5GList *	MHEG5resolveGenericBoolean (MHEG5GList *params, MHEG5Bool *value)
MHEG5GList *	MHEG5resolveGenericInteger (MHEG5GList *params, MHEG5Int *value)
MHEG5GList *	MHEG5resolveGenericOctetString (MHEG5GList *params, MHEG5String *value, MHEG5Bool *invalidString)
	Resolve a parameter reference to a generic octet string. The reference can be either direct or indirect.

---

Detailed Description

Implement functions to retrieve MHEG5objects by GroupID and ID.

Date:

01/02/2002

Author:

R.Freeman

---

Function Documentation

MHEG5String MHEG5getGroupId

(

MHEG5Root *

root

)

<Function description>="">

Returns:

<Return value>="">

MHEG5GList* MHEG5resolveGenericOctetString	(	MHEG5GList *	params,
		MHEG5String *	value,
		MHEG5Bool *	invalidString
	)

Resolve a parameter reference to a generic octet string. The reference can be either direct or indirect.

Parameters:

params	List of parameters. The first parameter in this list is parsed and a pointer to the next parameter in the list is returned by the function.
value	Resolved octet string
invalidString	True if the next parameter was not a valid octet string, otherwise False.

Returns:

Pointer to the next parameter in the parameter list, or NULL if no more parameters.

MHEG5GList* MHEG5resolveGenericORefProper	(	MHEG5GList *	params,
		MH5GroupRef *	pgroupRef,
		MHEG5Int *	id
	)

Resolve a generic object reference, returning the object reference. The reference can be direct or indirect. This function is similar to MHEG5resolveGenericORef, except that the object reference itself is returned (groupId + Id), rather than the object that it points to.

Parameters:

params	List of parameters. The first parameter in this list is parsed and a pointer to the next parameter in the list is returned by the function.
pgroupRef	Group of the generic object reference that is resolved.
id	ID of the generic object reference that is resolved.

Returns:

Pointer to the next parameter in the parameter list

Resolve a generic object reference, returning the object reference. The reference can be direct or indirect. This function is similar to MHEG5resolveGenericORef, except that the object reference itself is returned (groupId + Id), rather than the object that it points to.

Parameters:

params	List of parameters. The first parameter in this list is parsed and a pointer to the next parameter in the list is returned by the function.
pgroupRef	Group of the generic object reference that is resolved.
id	ID of the generic object reference that is resolved.

Returns:

Pointer to the next parameter in the parameter list, or NULL if no more parameters.