Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
.gif)
| Previous | Next |
IWMSPlayers::Remove
The Remove method disconnects a specific player from the server and removes it from the IWMSPlayers collection.
Syntax
HRESULT Remove( VARIANT varIndex );
Parameters
varIndex
[in] VARIANT that specifies the item to be removed from the collection. This value can be an index or a pointer to an IWMSPlayer interface.
Return Values
If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.
| Return code | Number | Meaning |
| DISP_E_BADINDEX | 0x8002000B | varIndex is an invalid index location. |
Remarks
If you created a previous instance of the IWMSPlayers collection, you must call IWMSPlayers::Refresh on that pointer to update the interface.
Example Code
#include <windows.h>
#include <atlbase.h> // Includes CComVariant.
#include "wmsserver.h"
// Declare variables and interfaces.
IWMSServer *pServer;
IWMSPlayers *pPlayers;
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 an IWMSPlayers interface
// and retrieve the total count of current connections.
hr = pServer->get_Players(&pPlayers);
if (FAILED(hr)) goto EXIT;
hr = pPlayers->get_Count(&lCount);
if (FAILED(hr)) goto EXIT;
// Remove the first connection from the collection.
varIndex = 0;
hr = pPlayers->Remove(varIndex);
if (FAILED(hr)) goto EXIT;
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
| Previous | Next |