IWMSOutgoingDistributionConnection::get_RequestedPlaylist

IWMSOutgoingDistributionConnection::get_RequestedPlaylist

The get_RequestedPlaylist method retrieves the client's requested playlist object.

Syntax

  HRESULT get_RequestedPlaylist(
  
  IWMSPlaylist**
  
  pVal
  
  );

Parameters

pVal

[out] Pointer to a pointer to an IWMSPlaylist interface. This method calls AddRef internally. To avoid memory leaks, you must call Release when you are finished using the interface.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Remarks

This object exists for an on-demand publishing point only if a client explicitly requests a playlist or a presentation that uses a server-side playlist. This object never exists for clients who access content from a broadcast publishing point.

Example Code

#include <windows.h>
#include <atlbase.h>    // Includes CComVariant.
#include "wmsserver.h"

// Declare variables and interfaces.
IWMSServer                          *pServer;
IWMSOutgoingDistributionConnections *pConnections;
IWMSOutgoingDistributionConnection  *pConnection;
IWMSPlaylist                        *pPlaylist;

HRESULT         hr;
CComVariant     varIndex;
long            lCount;

// Initialize the COM library and retrieve a pointer
// to an IWMSServer interface.
hr = CoInitialize(NULL);
hr = CoCreateInstance(CLSID_WMSServer,
                      NULL,
                      CLSCTX_ALL,
                      IID_IWMSServer,
                      (void **)&pServer);
if (FAILED(hr)) goto EXIT;

// Retrieve a pointer to a collection of distribution
// connections and retrieve the total count of connections.
hr = pServer->get_OutgoingDistributionConnections(&pConnections);
if (FAILED(hr)) goto EXIT;
hr = pConnections->get_Count(&lCount);
if (FAILED(hr)) goto EXIT;

// Retrieve information about each distribution connection.
for (long x = 0; x < lCount; x++)
{
    varIndex = x;
    hr = pConnections->get_Item(varIndex, &pConnection);
    if (FAILED(hr)) goto EXIT;

    // Retrieve the playlist requested by the client
    // if one exists.
    hr = pConnection->get_RequestedPlaylist(&pPlaylist);
    if (FAILED(hr)) goto EXIT;

    // Release temporary COM objects.
    pConnection->Release();
}

Requirements

Header: wmsserver.h.

Library: WMSServerTypeLib.dll.

Platform: Windows Server 2003 family, Windows Server 2008 family.

See Also

• IWMSOutgoingDistributionConnection Interface