CLAIMMEDIALABEL callback function (ntmsmli.h)

Article
02/22/2024

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

The ClaimMediaLabel callback function determines whether a specified media label was created by the media's associated application.

Syntax

CLAIMMEDIALABEL Claimmedialabel;

DWORD Claimmedialabel(
  [in]  const BYTE * const pBuffer,
  [in]  const DWORD nBufferSize,
  [out] MediaLabelInfo * const pLabelInfo
)
{...}

Parameters

[in] pBuffer

Pointer to a buffer that contains the media label.

[in] nBufferSize

Size of the buffer, in bytes.

[out] pLabelInfo

Pointer to a MediaLabelInfo structure. The media label library fills in this structure if the library recognizes the media label.

Return value

This function returns one of the following values.

Value	Meaning
NO_ERROR	The media label library filled in the MediaLabelInfo structure.
ERROR_BAD_FORMAT	The media label library does not recognize the media label.

Remarks

When a media label library uses the ClaimMediaLabel function to identify the media label as one created by its associated application, the media label library must fill in the MediaLabelInfo structure and return NO_ERROR. If the media label library does not recognize the media label, it returns ERROR_BAD_FORMAT.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	ntmsmli.h