IDirectXFile::CreateEnumObject Method

Creates an enumerator object.

Syntax

HRESULT CreateEnumObject(      

    LPVOID pvSource,
    DXFILELOADOPTIONS dwLoadOptions,
    LPDIRECTXFILEENUMOBJECT *ppEnumObj
);

Parameters

pvSource

[out] Pointer to data whose contents depend on the value of dwLoadOptions

dwLoadOptions

[in] Value that specifies the source of the data. This value can be one of the DXFILELOAD_xxx flags in DXFILE.

ppEnumObj

[out, retval] Address of a pointer to an IDirectXFileEnumObject interface, representing the created enumerator object.

Return Value

If the method succeeds, the return value is DXFILE_OK.

If the method fails, the return value can be one of the following values.

DXFILEERR_BADALLOC	Memory allocation failed.
DXFILEERR_BADFILEFLOATSIZE	Floating-point size is invalid.
DXFILEERR_BADFILETYPE	File is not a Microsoft?DirectX?(.x) file.
DXFILEERR_BADFILEVERSION	File version is not valid.
DXFILEERR_BADRESOURCE	Resource is invalid.
DXFILEERR_BADVALUE	Parameter is invalid.
DXFILEERR_FILENOTFOUND	File could not be found.
DXFILEERR_RESOURCENOTFOUND	Resource could not be found.
DXFILEERR_URLNOTFOUND	URL could not be found.

Remarks

After using this method, use one of the IDirectXFileEnumObject methods to retrieve a data object.

See Also

IDirectXFileEnumObject