IAAFLocator Interface Reference

The IAAFLocator interface is implemented by objects that provide information to help find a file that contains the essence. More...

List of all members.

Public Member Functions
HRESULT	SetPath ([in, string] aafCharacter_constptr pPath)
	Sets the Path string property.
HRESULT	GetPath ([out, string, size_is(bufSize)] aafCharacter *pPath,[in] aafUInt32 bufSize)
	Gets the Path string property.
HRESULT	GetPathBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetPath().

---

Detailed Description

The IAAFLocator interface is implemented by objects that provide information to help find a file that contains the essence.

In addition to the specific error results listed for each method, all methods in this interface may also return one of the following values:

AAFRESULT_NOMEMORY

• insufficient system memory is available to perform the operation.

AAFRESULT_NOT_INITIALIZED

• This object has not yet had Initialize() called on it through this object's primary interface. Note that IAAFLocator is a primary interface for an abstract class, so it is not appropriate for the Initialize() method to exist in this interface. The Initialize() method is available through the concrete object's primary interface. Objects that implement IAAFLocator also implement the following interfaces:

IAAFObject

Definition at line 12864 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFLocator::GetPath	(	[out, string, size_is(bufSize)] aafCharacter *	pPath,
		[in] aafUInt32	bufSize
	)

Gets the Path string property.

Writes the Path property, with a trailing null character, into the pPath buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize. If the Path property has not yet been set, a zero-length string will be written (that is, only the trailing null character).

Caller may call GetPathBufLen() to determine the required buffer size.

If this method fails nothing will be written to pPath.

Succeeds if:

• The pPath pointer is valid.
• bufSize indicates that the buffer is large enough to hold Path.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

• succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

• pPath arg is NULL.

AAFRESULT_SMALL_BUF

• bufSize indicates that the allocated buffer is not large enough to hold Path.

Parameters:

pPath	[out, string, size_is(bufSize)] buffer into which Path is to be written
bufSize	[in] size of *pPath buffer in bytes

HRESULT IAAFLocator::GetPathBufLen

(

[out] aafUInt32 *

pBufSize

)

Returns size of buffer (in bytes) required for GetPath().

Succeeds if:

• The pBufSize pointer is valid.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

• succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

• pBufSize arg is NULL.

Parameters:

pBufSize

[out] size of required buffer, in bytes

HRESULT IAAFLocator::SetPath

(

[in, string] aafCharacter_constptr

pPath

)

Sets the Path string property.

Set the Path property to the value specified in pPath. A copy is made of the data so the caller retains ownership of the *pPath buffer and is responsible for de-allocating it. There is no pre-set limit to the length of the name, other than available system memory or disk space.

Succeeds if all of the following are true:

• the pPath pointer is valid.

If this method fails the Path property will not be changed.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

• succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

• pPath arg is NULL.

Parameters:

pPath

[in, string] buffer from which Path is to be read