ClaimMediaLabel Callback Function

Article
06/09/2011

[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

DWORD WINAPI ClaimMediaLabel(
  __in   const BYTE const *pBuffer,
  __in   const DWORD nBufferSize,
  __out  MediaLabelInfo const *pLabelInfo
);

Parameters

pBuffer [in]
Pointer to a buffer that contains the media label.
nBufferSize [in]
Size of the buffer, in bytes.
pLabelInfo [out]
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

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	NtmsMli.h