IWMSPublishingPoint::put_EnableWrapperPath

The put_EnableWrapperPath method specifies a Boolean value that indicates whether a wrapper playlist is enabled for the publishing point.

HRESULT put_EnableWrapperPath(
  VARIANT_BOOL  newVal
);

Arguments

newVal

[in] VARIANT_BOOL that indicates whether a wrapper playlist is enabled. By default, this parameter is VARIANT_FALSE.

Return Value

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

Return code	Number	Description
NS_E_PUBLISHING_POINT_REMOVED	0xC00D145AL	Indicates that the publishing point was already removed.
NS_E_WRONG_PUBLISHING_POINT_TYPE	0xC00D1452L	Indicates that the method is not supported for cache proxy publishing points.

Remarks

For more information about wrapper playlists, see the IWMSPublishingPoint::put_WrapperPath method.

This method is not supported for cache proxy publishing points. Also, wrapper playlists are not used with broadcast data sinks. Therefore, the server will not use items in a wrapper playlist to send data to a multicast stream or to send data to an archive sink for archiving.

Example

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

// Declare variables and interfaces.
IWMSServer              *pServer;
IWMSPublishingPoints    *pPubPoints;
IWMSPublishingPoint     *pPubPoint;

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 the IWMSPublishingPoints interface
// and retrieve the total count of publishing points.
hr = pServer->get_PublishingPoints(&pPubPoints);
if (FAILED(hr)) goto EXIT;
hr = pPubPoints->get_Count(&lCount);
if (FAILED(hr)) goto EXIT;

// Retrieve information about each publishing point.
for (long x = 0; x < lCount; x++)
{
    varIndex = x;
    hr = pPubPoints->get_Item(varIndex, &pPubPoint);
    if (FAILED(hr)) goto EXIT;

    // Set a Boolean value that indicates that
    // wrapper playlists are enabled.
    hr = pPubPoint->put_EnableWrapperPath(VARIANT_TRUE);
    if (FAILED(hr)) goto EXIT;

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

EXIT:
    // TODO: Release temporary COM objects and uninitialize COM.

Requirements

Header: wmsserver.h.

Library: WMSServerTypeLib.dll.

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

See Also

Reference

IWMSPublishingPoint Interface