IWMSFileDescription::get_Name
.gif)
| Previous | Next |
IWMSFileDescription::get_Name
The get_Name method retrieves the name of a directory, media file, or playlist file.
Syntax
HRESULT get_Name( BSTR* pVal );
Parameters
pVal
[out] Pointer to a BSTR containing the name.
Return Values
If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.
| Return code | Number | Description |
| E_OUTOFMEMORY | 0x8007000E | There is insufficient memory to complete the function. |
| E_POINTER | 0x80004003 | pVal is a NULL pointer argument. |
Remarks
This method requires the Network Service account to have read and browse access to the file being described.
Example Code
#include <windows.h>
#include <atlbase.h> // Includes CComBSTR and CComVariant.
#include "wmsserver.h"
// Declare variables and interfaces.
IWMSServer *pServer;
IWMSFileDescriptions *pFileDescriptions;
IWMSFileDescription *pFileDescription;
HRESULT hr;
CComVariant varIndex;
CComBSTR bstrPath;
CComBSTR bstrName;
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 IWMSFileDescriptions interface
// and retrieve the total count of descriptions.
bstrPath = "file://c:\\wmpub\\wmroot";
hr = pServer->get_FileDescriptions(bstrPath,
WMS_FILE_UNSPECIFIED,
&pFileDescriptions);
if (FAILED(hr)) goto EXIT;
hr = pFileDescriptions->get_Count(&lCount);
if (FAILED(hr)) goto EXIT;
// Retrieve information associated with each description.
for (long x = 0; x < lCount; x++) {
varIndex = x;
hr = pFileDescriptions->get_Item(varIndex, &pFileDescription);
if (FAILED(hr)) goto EXIT;
// Retrieve the name of the file.
hr = pFileDescription->get_Name(&bstrName);
if (FAILED(hr)) goto EXIT;
// Release temporary COM objects.
pFileDescription->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
| Previous | Next |