This interface is used to allow the user to determine the byte order of this object. More...

Public Member Functions
HRESULT	GetStoredByteOrder ([out] eAAFByteOrder_t *pOrder)
	Returns the "Endian-ness" in which the current object was or will be stored.
HRESULT	GetNativeByteOrder ([out] eAAFByteOrder_t *pOrder)
	Returns the native "Endian-ness" of the platform on which this is running.

Detailed Description

This interface is used to allow the user to determine the byte order of this object.

Note that the byte order of the object stored in the AAF file may be different from the native byte order of this machine. Note also that both pieces of information are available here.

Byte order of newly created AAF files is set upon creation of that file. It is set to the byte order of the creating machine.

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 IAAFEndian is not a primary interface for a concrete 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.

Definition at line 44353 of file AAF.idl.

Member Function Documentation

HRESULT IAAFEndian::GetNativeByteOrder ( [out] eAAFByteOrder_t * pOrder )

Returns the native "Endian-ness" of the platform on which this is running.

Succeeds if all of the following are true:

the pOrder pointer is valid.

If this method fails nothing is written to *pOrder.

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

pOrder is null.

Parameters:

pOrder [out] Pointer to place where byte order is to be put

HRESULT IAAFEndian::GetStoredByteOrder ( [out] eAAFByteOrder_t * pOrder )

Returns the "Endian-ness" in which the current object was or will be stored.

If this is a transient object (i.e., one which has not been persisted) then it will return the native byte order of the platform on which this is running.