Start of the comment. More...

Public Member Functions
HRESULT	GetName ([out, string, size_is(bufSize)] aafCharacter *pName,[in] aafUInt32 bufSize)
	Gets the name of this file encoding.
HRESULT	GetNameBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetName().
HRESULT	GetDescription ([out, string, size_is(bufSize)] aafCharacter *pDescription,[in] aafUInt32 bufSize)
	Gets the description of this file encoding.
HRESULT	GetDescriptionBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetDescription().
HRESULT	GetFileKind ([out] aafUID_t *pFileKind)
	This method returns the unique ID associated with this file encoding.

Detailed Description

Start of the comment.

End of the comment

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.

Definition at line 9970 of file AAF.idl.

Member Function Documentation

HRESULT IAAFFileEncoding::GetDescription	(	[out, string, size_is(bufSize)] aafCharacter *	pDescription,
		[in] aafUInt32	bufSize
	)

Gets the description of this file encoding.

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

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

If this method fails nothing will be written to pDescription.

Succeeds if:

The pDescription pointer is valid.
bufSize indicates that the buffer is large enough to hold Description.

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

pDescription arg is NULL.

AAFRESULT_SMALL_BUF

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

Parameters:

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

HRESULT IAAFFileEncoding::GetDescriptionBufLen ( [out] aafUInt32 * pBufSize )

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

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 IAAFFileEncoding::GetFileKind ( [out] aafUID_t * pFileKind )

This method returns the unique ID associated with this file encoding.

Succeeds if all of the following are true:

the object is initialized.
the pFileKind pointer is valid.

If this method fails nothing will be written to *pFileKind.

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_NOT_INITIALIZED

the object is not initialized.

AAFRESULT_NULL_PARAM

pFileKind argument is NULL.

Parameters:

pFileKind [out] The unique file encoding ID

HRESULT IAAFFileEncoding::GetName	(	[out, string, size_is(bufSize)] aafCharacter *	pName,
		[in] aafUInt32	bufSize
	)

Gets the name of this file encoding.

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

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

If this method fails nothing will be written to pName.

Succeeds if:

The pName pointer is valid.
bufSize indicates that the buffer is large enough to hold Name.

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

pName arg is NULL.

AAFRESULT_SMALL_BUF

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

Parameters:

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

HRESULT IAAFFileEncoding::GetNameBufLen ( [out] aafUInt32 * pBufSize )

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

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

Public Member Functions

Detailed Description

Member Function Documentation