GetNtmsMediaPoolNameA function

[Removable Storage Manager is no longer available as of Windows 7 and Windows Server 2008 R2.]

The GetNtmsMediaPoolName function retrieves the specified media pool's full name hierarchy.

Syntax

DWORD GetNtmsMediaPoolNameA(
  HANDLE      hSession,
  LPNTMS_GUID lpPoolId,
  LPSTR       lpNameBuf,
  LPDWORD     lpdwBufSize
);

Parameters

hSession

Handle to the session returned by the OpenNtmsSession function.

lpPoolId

Unique identifier of the media pool whose name is to be retrieved.

lpNameBuf

TBD

lpdwBufSize

Size of the lpBufName buffer, on input. On output, the number of characters in the full name hierarchy.

Return Value

This function returns one of the following values.

Value Meaning
ERROR_INSUFFICIENT_BUFFER
The buffer size is not large enough. The correct size is returned in lpdwBufSize.
ERROR_INVALID_HANDLE
The value specified in the hSession parameter is NULL or is not valid.
ERROR_INVALID_MEDIA_POOL
The media pool ID is missing or is not valid.
ERROR_INVALID_PARAMETER
The parameter is missing or is not valid.
ERROR_NOT_ENOUGH_MEMORY
The memory allocation failed.
ERROR_SUCCESS
The function was successful.

Requirements

   
Windows version Windows XP [desktop apps only] Windows Server 2003 [desktop apps only]
Target Platform Windows
Header ntmsapi.h
Library Ntmsapi.lib
DLL Ntmsapi.dll

See Also

CreateNtmsMediaPool

Media Services Functions