GetNtmsMediaPoolName

[This is preliminary documentation and subject to change.]

The GetNtmsMediaPoolName function returns the specified media pool's full name hierarchy into the output buffer.

DWORD WINAPI GetNtmsMediaPoolName(
  HANDLE hSession,
  LPNTMS_GUID lpPoolId,
  LPTSTR lpBufName,
  LPDWORD lpdwBufSize
);
 

Parameters

hSession

Handle to the session returned by the OpenNtmsSession function.

lpPoolId

Specifies the GUID of the media pool to retrieve the name.

lpBufName

Specifies the name of the output buffer.

lpdwBufSize

Specifies the size of the name data buffer on input. Returns the number of characters (string length) of the full name.

Return Values

ERROR_INSUFFICIENT_BUFFER

The buffer size was not correctly specified. The correct size is returned in lpdwBufSize.

ERROR_INVALID_HANDLE

The value specified in the hSession parameter is NULL or invalid.

ERROR_INVALID_MEDIA_POOL

The media pool ID is missing or invalid.

ERROR_INVALID_PARAMETER

The parameter is missing or invalid.

ERROR_NOT_ENOUGH_MEMORY

The memory allocation failed.

ERROR_SUCCESS

The function was successful.

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in ntmsapi.h.
  Import Library: Use ntmsapi.lib.

See Also

Media Services Functions, CreateNtmsMediaPool