mme_metadata_image_unload()

Clear image from temporary storage

Synopsis:

#include <mme/mme.h>

int mme_metadata_image_unload( mme_metadata_session_t *session,
                               uint64_t mdimage_rid );,

Arguments:

session
A pointer to a metadata session structure.
mdimage_rid
A metadata image request ID, obtained by a call to a mme_metadata_getinfo_*() function.

Library:

mme

Description:

The function mme_metadata_image_unload() removes from temporary storage an image loaded by mme_metadata_image_load(). The image to remove from temporary storage is identified by the mdimage_rid, which was generated by a mme_metadata_image_load() function when it retrieved an image for a file.

If mme_metadata_image_unload() is called while an image is loading, the call cancels the load, and the MME delivers the event with the mme_event_metadata_image_t error member set to ECANCELED.

You must call mme_metadata_create_session() to create a metadata session before using mme_metadata_unload().

Events

None delivered.

Blocking and validation

This function doesn't block.

Returns:

0
Success.
-1
An error occurred (errno is set).

Classification:

QNX Neutrino

Safety:
Interrupt handler No
Signal handler No
Thread Yes

See also:

mme_metadata_create_session(), mme_metadata_free_session(), mme_metadata_getinfo_current(), mme_metadata_getinfo_file(), mme_metadata_getinfo_library(), mme_metadata_image_cache_clear(), mme_metadata_image_load(), mme_metadata_image_url_t, mme_metadata_info_t, mme_metadata_session_t