GetNtmsMediaPoolName 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 GetNtmsMediaPoolName(
__in HANDLE hSession,
__in LPNTMS_GUID lpPoolId,
__out LPTSTR lpBufName,
__inout LPDWORD lpdwBufSize
);
Parameters
hSession [in]
Handle to the session returned by the OpenNtmsSession function.lpPoolId [in]
Unique identifier of the media pool whose name is to be retrieved.lpBufName [out]
Pointer to a buffer that receives the name of the media pool.lpdwBufSize [in, out]
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
Minimum supported client |
Windows 2000 Professional |
Minimum supported server |
Windows 2000 Server |
End of client support |
Windows Vista |
End of server support |
Windows Server 2008 |
Header |
Ntmsapi.h |
Library |
Ntmsapi.lib |
DLL |
Ntmsapi.dll |
Unicode and ANSI names |
GetNtmsMediaPoolNameW (Unicode) and GetNtmsMediaPoolNameA (ANSI) |
See Also
Send comments about this topic to Microsoft
Build date: 6/9/2011