API Guide
601355 Rev A API Functions 2-43
Functions
Return Values VS_ArchiveMediaClass_GetFields returns:
•VSE_TRUE - Successful execution.
•VSE_FALSE - API failure - An appropriate error code is set
in VSG_Error.
•VSE_ERR_BADFIELD - An invalid parameter was
specified.
•VSE_ERR_BADHANDLE - Specified handle was not an
archive media class handle.
•VSE_ERR_NULLHANDLE - Specified handle was a null
pointer.
VSID_MEDIA_TYPE_NAME
(VST_MEDIA_TYPE_NAME) Pointer to the media type associated with the
archive media class. Valid media type names
may contain up to 16 alphanumeric
characters, including spaces. Leading and
trailing spaces are not permitted.
VSID_MIGRATION_PRIORITY
(VST_PRIORITY *) Pointer to the migration priority to be applie d
to this archive media class.
VSID_NUMBER_COMPONENT_HANDLES
(int *) Pointer to the number of component handles
present in the component handle table.
VSID_PERCENT (VST_PERCENT *) Pointer to the percentage of the media
assigned to the related MediaClass group
allowed in the archive associated with the
archive media class relationship.
VSID_TARGET_ARCHIVE_NAME
(VST_ARCHIVE_NAME) Pointer to the destination archive for media
automatically migrated out of this archive
media class. Valid archive names may co ntain
up to 16 alphanumeric characters, including
spaces. Leading and trailing spaces are not
permitted.
Parameter Type Description