mme_metadata_free_session()

End a metadata session

Synopsis:

#include <mme/mme.h>

int mme_metadata_free_session( mme_metadata_session_t *session );

Arguments:

session
A pointer to a metadata session structure.

Library:

mme

Description:

The function mme_metadata_free_session() frees the memory and the images used in a metadata session.

Every metadata session consumes system resources. The client application should always call this function to end a metadata session when the data requested in that session is no longer needed.

Events

None delivered.

Blocking and validation

This function will cancel any pending metadata or image requests before returning. These cancellations may delay the return of the this function.

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_getinfo_current(), mme_metadata_getinfo_file(), mme_metadata_getinfo_library(), mme_metadata_image_cache_clear(), mme_metadata_image_load(), mme_metadata_image_unload(), mme_metadata_image_url_t, mme_metadata_info_t, mme_metadata_session_t