Share via

IWMSPublishingPoint::get_FileDescriptions

  • Article

banner art

Previous Next

IWMSPublishingPoint::get_FileDescriptions

The get_FileDescriptions method retrieves an IWMSFileDescriptions collection that contains information about files, directories, and playlists in a specified publishing point path.

Syntax

  HRESULT get_FileDescriptions(
  BSTR  RelativePath,
  IWMSFileDescriptions**  pVal
);

Parameters

RelativePath

[in] BSTR that contains a subdirectory or file in the base path. You can use the IWMSPublishingPoint::put_Path method to specify the base path.

pVal

[out] Pointer to a pointer to an IWMSFileDescriptions interface. This is NULL if the publishing point path does not contain a directory, media file or playlist file. You can use the IWMSPublishingPoint::get_Path method to retrieve the publishing point path.

Return Values

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

Return code Number Description
E_POINTER 0x80004003 Indicates that pVal is a NULL pointer argument.
ERROR_FILE_NOT_FOUND 0x00000002 Indicates that the file that was indicated by RelativePath was not found.
ERROR_PATH_NOT_FOUND 0x00000003 Indicates that the path that was indicated by RelativePath was not found.
NS_E_DATA_SOURCE_ENUMERATION_NOT_SUPPORTED 0xC00D1580L Indicates that the data source plug-in that the server is attempting to use to access the path referenced by RelativePath does not support enumeration of files.
NS_E_PUBLISHING_POINT_REMOVED 0xC00D145AL Indicates that the publishing point was already removed.
NS_E_SOURCE_PLUGIN_NOT_FOUND 0xC00D157EL Indicates that the server was not able to find a data source plug-in to access the path referenced by RelativePath.
NS_E_WRONG_PUBLISHING_POINT_TYPE 0xC00D1452L Indicates that the method is not supported for cache proxy publishing points.

Remarks

If the publishing point path contains either a media file or playlist file, the IWMSFileDescriptions interface will contain information about only that file, and an error is returned if any value other than a zero-length string is specified in the first parameter.

This method is not supported for cache proxy publishing points.

This method requires the Network Service account to have read and browse access to the specified path.

This method calls AddRef internally. To avoid memory leaks, you must call Release when you are finished using the interface.

Example Code

  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