PlaylistCollection.getByName 方法

[與此頁面相關聯的功能Windows 媒體播放機 SDK是舊版功能。 它已被 MediaPlayer 取代MediaPlayer已針對Windows 10和Windows 11進行優化。 Microsoft 強烈建議新程式碼盡可能使用MediaPlayer,而不是Windows 媒體播放機 SDK。 Microsoft 建議盡可能重寫使用舊版 API 的現有程式碼,以使用新的 API。]

如果有任何存在, getByName 方法會擷取 PlaylistArray 物件,其中包含具有指定名稱的播放清單。

語法

retVal = PlaylistCollection.getByName(
  name
)

參數

name [in]

包含 要擷取之播放清單名稱的字串。

傳回值

這個方法會傳回 PlaylistArray 物件。

備註

使用 PlaylistArray用來 判斷播放清單是否存在的計數。 如果 count 為零,則播放清單不存在。

若要使用此方法,需要程式庫的讀取權限。 如需詳細資訊,請參閱 程式庫存取

範例

下列 JScript 範例使用 playlistCollectiongetByName 可檢查 playlistCollection 物件是否有名為 「ThreeList」 的播放清單。 如果 「Threelist」 播放清單存在, getByName 會將 「ThreeList」 設定為目前的播放清單。 Player物件是以識別碼 = 「Player」 建立。

//Retrieve the count of the playlists named "ThreeList".
var Checkit = Player.playlistCollection.getByName("ThreeList").count;

//Since duplicate playlist names are allowed, the count returned
//will be either zero (no playlist) or greater than zero 
//(playlist exists).
if (Checkit > 0){ 
    
   //Retrieve a playlistArray object containing "ThreeList". Assume that
   //there is only one playlist with that name, and assign it to the 
   //current playlist.
   Player.currentPlaylist = Player.playlistCollection.getByName("ThreeList").item(0);
}

規格需求

需求
版本
Windows 媒體播放機 7.0 版或更新版本。
DLL
Wmp.dll

另請參閱

PlaylistArray 物件

PlaylistArray.count

PlaylistCollection 物件

Settings.mediaAccessRights

Settings.requestMediaAccessRights