IWMSPublishingPoint Interface

  • Article

banner art

Previous Next

IWMSPublishingPoint Interface

The IWMSPublishingPoint interface supports the basic properties that describe both on-demand and broadcast publishing points. Additional properties and methods supported by on-demand and broadcast publishing points are available through the IWMSOnDemandPublishingPoint and IWMSBroadcastPublishingPoint interfaces. These interfaces can be accessed by calling QueryInterface on the IWMSPublishingPoint interface.

In addition to the methods inherited from IDispatch, the IWMSPublishingPoint interface exposes the following methods.

Method Description
get_AllowClientsToConnect Retrieves a Boolean value that indicates whether the publishing point can receive client connections.
get_AllowPlayerSideDiskCaching Retrieves a Boolean value that indicates whether the publishing point allows clients to cache content locally.
get_Authenticators Retrieves an IWMSPlugins interface that contains a collection of authentication plug-ins.
get_CacheProxyExpiration Retrieves the expiration value for cached content.
get_CurrentCounters Retrieves an IWMSPublishingPointCurrentCounters interface that contains counters that are maintained by the publishing point.
get_DistributionUserName Retrieves the user name that is provided by the client in response to an authentication challenge sent during server-to-server distribution.
get_EnableFEC Retrieves a value that indicates whether Forward Error Correction is enabled.
get_EnableWrapperPath Retrieves a Boolean value that indicates whether a wrapper playlist is enabled for the publishing point.
get_EventHandlers Retrieves an IWMSPlugins interface that contains a collection of event authorization and notification plug-ins.
get_FileDescriptions Retrieves an IWMSFileDescriptions collection that contains information about files, directories, and playlists in a specified publishing point path.
get_ID Retrieves a unique CLSID for the publishing point.
get_IsDistributionPasswordSet Retrieves a VARIANT_BOOL that indicates whether the password that is returned in response to an authentication challenge during server-to-server distribution is set.
get_Limits Retrieves an IWMSPublishingPointLimits interface that contains information about limits maintained by the publishing point.
get_MonikerName Retrieves the moniker name for a publishing point.
get_Name Retrieves the name of the publishing point.
get_OutgoingDistributionConnections Retrieves an IWMSOutgoingDistributionConnections collection that contains information about distribution connections.
get_Path Retrieves the path to the publishing point content.
get_PeakCounters Retrieves an IWMSPublishingPointPeakCounters interface that contains information about peak counters maintained by the publishing point.
get_Players Retrieves an IWMSPlayers interface that contains information about connected players.
get_Properties Retrieves an IWMSNamedValues interface that contains a collection of name/value pairs for the publishing point.
get_Status Retrieves the publishing point status.
get_StreamFilters Reserved for future use.
get_TotalCounters Retrieves an IWMSPublishingPointTotalCounters interface that contains information about the total counters maintained by the publishing point.
get_Type Retrieves an enumeration value that indicates the publishing point type.
get_WrapperPath Retrieves the path to a wrapper playlist file.
put_AllowClientsToConnect Specifies a Boolean value that indicates whether the publishing point can receive client connections.
put_AllowPlayerSideDiskCaching Specifies a Boolean value that indicates whether the publishing point allows clients to cache content locally.
put_CacheProxyExpiration Specifies the expiration value for cached content.
put_EnableFEC Specifies whether to enable Forward Error Correction (FEC).
put_EnableWrapperPath Specifies a Boolean value that indicates whether a wrapper playlist is enabled for the publishing point.
put_Name Specifies the name of the publishing point.
put_Path Specifies the path to the publishing point content.
put_WrapperPath Specifies the path to a wrapper playlist file.
SetDistributionUserNamePassword Specifies the password and user name to use in response to an authentication challenge sent during server-to-server distribution.

Example Code

The following example illustrates how to retrieve a pointer to an IWMSPublishingPoint interface.

#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;

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

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

See Also

Previous Next