Name
hw_ConfigureLoaderAdapter -- configure a loader or adapter (V6.0)
Synopsis
int hw_ConfigureLoaderAdapter(hwPluginBase *self, ULONG type, ULONG flags,
                                struct hwTagList *tags);
Function
This function allows you to configure your loader or adapter plugin. Since Hollywood might call into your loader or adapter even if it hasn't been activated, it is recommended to always call this function from inside your InitPlugin() implementation, i.e. before you call hw_AddLoaderAdapter(). This ensures that your loader or adapter plugin always uses the configuration you want it to use, no matter if it is manually activated by hw_AddLoaderAdapter() or if Hollywood is calling directly into it.

The second parameter specifies the type of the loader or adapter you want to configure. See hw_AddLoaderAdapter for a list of supported types.

The third and fourth parameters depend on the type passed as parameter 2. The following flags and tags are currently recognized:

HWPLUG_CAPS_FILEADAPTER:
File adapter plugins currently support the following flags:

HWCLAFAFLAGS_CHUNKLOADER:
If this flag is set, you indicate that your file adapter's FOpen() implementation supports loading of chunked files. If you set this flag, your FOpen() implementation must support the HWFOPENTAG_CHUNKXXX tags. See FOpen for details.

HWCLAFAFLAGS_MUSTREQUIRE:
If this flag is set, the file adapter will only be available if @REQUIRE has been called on your plugin. This can be useful if your RequirePlugin() function does some important initialization which you don't want to do in InitPlugin() for whatever reason. Hollywood will then make sure to only call your file adapter if it has been properly @REQUIRE'd first. (V7.1)

HWPLUG_CAPS_DIRADAPTER:
Directory adapter plugins currently support the following flags:

HWCLADAFLAGS_MUSTREQUIRE:
If this flag is set, the directory adapter will only be available if @REQUIRE has been called on your plugin. This can be useful if your RequirePlugin() function does some important initialization which you don't want to do in InitPlugin() for whatever reason. Hollywood will then make sure to only call your directory adapter if it has been properly @REQUIRE'd first. (V7.1)

HWPLUG_CAPS_IMAGE:
Image plugins currently support the following flags:

HWCLAIMGFLAGS_MUSTREQUIRE:
If this flag is set, the image plugin will only be available if @REQUIRE has been called on your plugin. This can be useful if your RequirePlugin() function does some important initialization which you don't want to do in InitPlugin() for whatever reason. Hollywood will then make sure to only call your image plugin if it has been properly @REQUIRE'd first. (V7.1)

HWPLUG_CAPS_ANIM:
Anim plugins currently support the following flags:

HWCLAANMFLAGS_MUSTREQUIRE:
If this flag is set, the anim plugin will only be available if @REQUIRE has been called on your plugin. This can be useful if your RequirePlugin() function does some important initialization which you don't want to do in InitPlugin() for whatever reason. Hollywood will then make sure to only call your anim plugin if it has been properly @REQUIRE'd first. (V7.1)

HWPLUG_CAPS_SOUND:
Sound plugins currently support the following flags:

HWCLASNDFLAGS_MUSTREQUIRE:
If this flag is set, the sound plugin will only be available if @REQUIRE has been called on your plugin. This can be useful if your RequirePlugin() function does some important initialization which you don't want to do in InitPlugin() for whatever reason. Hollywood will then make sure to only call your sound plugin if it has been properly @REQUIRE'd first. (V7.1)

HWPLUG_CAPS_VIDEO:
Video plugins currently support the following flags:

HWCLAVIDFLAGS_MUSTREQUIRE:
If this flag is set, the video plugin will only be available if @REQUIRE has been called on your plugin. This can be useful if your RequirePlugin() function does some important initialization which you don't want to do in InitPlugin() for whatever reason. Hollywood will then make sure to only call your video plugin if it has been properly @REQUIRE'd first. (V7.1)

HWPLUG_CAPS_NETWORKADAPTER:
Network adapter plugins currently support the following flags:

HWCLANAFLAGS_MUSTREQUIRE:
If this flag is set, the network adapter will only be available if @REQUIRE has been called on your plugin. This can be useful if your RequirePlugin() function does some important initialization which you don't want to do in InitPlugin() for whatever reason. Hollywood will then make sure to only call your network adapter if it has been properly @REQUIRE'd first. (V8.0)

HWPLUG_CAPS_ICON:
Icon plugins currently support the following flags:

HWCLAICONFLAGS_MUSTREQUIRE:
If this flag is set, the icon plugin will only be available if @REQUIRE has been called on your plugin. This can be useful if your RequirePlugin() function does some important initialization which you don't want to do in InitPlugin() for whatever reason. Hollywood will then make sure to only call your icon plugin if it has been properly @REQUIRE'd first. (V9.0)

Designer compatibility
Unsupported

Inputs
self
hwPluginBase pointer passed to InitPlugin()
type
loader or adapter type (see above)
flags
desired flags for the loader or adapter (see above)
tags
currently unused; pass NULL
Results
error
error code or 0 for success

Show TOC