3.2.5.2.2.11 INtmsMediaServices1::GetNtmsMediaPoolNameA (Opnum 14)

The GetNtmsMediaPoolNameA method retrieves the full name hierarchy of a media pool, with null-terminated strings encoded using ASCII.

 HRESULT GetNtmsMediaPoolNameA(
   [in] LPNTMS_GUID lpPoolId,
   [out, size_is(*lpdwNameSizeBuf), length_is(*lpdwNameSizeBuf)] 
     unsigned  char* lpBufName,
   [in] DWORD* lpdwNameSizeBuf,
   [out] DWORD* lpdwNameSize
 );

lpPoolId: A pointer to the identifier of the media pool from which to retrieve the name.

lpBufName: A null-terminated buffer that contains the name of the media pool.

lpdwNameSizeBuf:  A pointer to the size, in bytes, of lpBufName.

lpdwNameSize:  A pointer to the length of the string in lpBufName, including the terminating null character.

Return value/code

Description

0x00000000

S_OK

The call was successful.

0x80070005

ERROR_ACCESS_DENIED

Access to an object was denied.

0x80070008

ERROR_NOT_ENOUGH_MEMORY

An allocation error occurred during processing.

0x80070057

ERROR_INVALID_PARAMETER

A parameter is missing or invalid.

0x8007007A

ERROR_INSUFFICIENT_BUFFER

The buffer is not large enough. The required size is returned in lpdwNameSize.

0x800710CE

ERROR_INVALID_MEDIA_POOL

The media pool identifier is missing or invalid.

Upon receiving this message, the server MUST verify that lpPoolName, lpdwNameSize, and lpBufName are not NULL. If parameter validation fails, the server MUST immediately fail the operation and return ERROR_INVALID_PARAMETER (0x80070057).

If parameter validation succeeds, the server MUST verify that the user has the required access rights, retrieve the name hierarchy for the given media pool, and return it to the caller in the lpBufName buffer. If the client does not have the required access rights, the server MUST return ERROR_ACCESS_DENIED (0x80070005).

Strings sent to this method as parameters MUST be ASCII-encoded.