GetMediaParameterName

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

Retrieves the name of the specified parameter for an indexed Advanced Stream Redirector (ASX) entry.

Compatibility:Windows Media Player

sRetVal = MediaPlayer.GetMediaParameterName(
lEntryNum, lParamNum
)

Parameters

lEntryNum

Long value specifying the index number of an ENTRY element in the ASX file.

lParamNum

Long value specifying the index number of a PARAM element within the specified ENTRY element.

Return Values

Returns a Stringvalue representing the NAMEattribute of the specified PARAMelement. This method returns a null value if lEntryNumis outside the range of the EntryCountproperty, or if no PARAMelement numbered lParamNumexists within the specified ENTRYelement.

Remarks

The PARAM element allows you to place additional information into an ASX file, which the Microsoft Windows Media Player control can then access through scripting. For example, you could insert the names of the producers of each media file inside the ASX file and display them in HTML somewhere near the Windows Media Player window.

Use this method to determine the names of the PARAM elements within an ASX ENTRY element. You can then call the GetMediaParametermethod to determine the value associated with each name.

The first ENTRY element in an ASX file has an lEntryNumindex number of 1. Index number 0is reserved for child elements of the ASX tag, which applies to information valid for the entire show.

An example ASX file might look like the following.

<ASX VERSION="3.0"> <TITLE>The Title
of the Show<TITLE> <ENTRY> <REF
HREF="YourMediaFilename.asf" /> <TITLE>The Title of the
Track</TITLE> <PARAM NAME="Producer" VALUE="Jane D.">
</ENTRY> </ASX>

To retrieve the name of the first PARAM element, call the method as shown below.

MediaPlayer.GetMediaParameterName( 1, 1 );

This method call would return the string Producer.

See Also

EntryCount, GetMediaParameter