GetNtmsMediaPoolNameW function (ntmsapi.h)
[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 GetNtmsMediaPoolNameW(
[in] HANDLE hSession,
[in] LPNTMS_GUID lpPoolId,
[out] LPWSTR lpNameBuf,
[in, out] LPDWORD lpdwBufSize
);
Parameters
[in] hSession
Handle to the session returned by the OpenNtmsSession function.
[in] lpPoolId
Unique identifier of the media pool whose name is to be retrieved.
[out] lpNameBuf
Pointer to a buffer that receives the name of the media pool.
[in, out] 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 |
|---|---|
|
The buffer size is not large enough. The correct size is returned in lpdwBufSize. |
|
The value specified in the hSession parameter is NULL or is not valid. |
|
The media pool ID is missing or is not valid. |
|
The parameter is missing or is not valid. |
|
The memory allocation failed. |
|
The function was successful. |
Remarks
Note
The ntmsapi.h header defines GetNtmsMediaPoolName as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | ntmsapi.h |
| Library | Ntmsapi.lib |
| DLL | Ntmsapi.dll |