UpdateNtmsOmidInfo function (ntmsapi.h)
[Removable Storage Manager is no longer available as of Windows 7 and Windows Server 2008 R2.]
The UpdateNtmsOmidInfo function updates the RSM database with label information immediately after writing to the newly allocated medium.
DWORD UpdateNtmsOmidInfo(
[in] HANDLE hSession,
[in] LPNTMS_GUID lpMediaId,
[in] DWORD labelType,
[in] DWORD numberOfBytes,
[in] LPVOID lpBuffer
);
[in] hSession
Handle to the session returned by the OpenNtmsSession function.
[in] lpMediaId
Unique identifier of a piece of logical media.
[in] labelType
Label type. This parameter can be one of the following values.
[in] numberOfBytes
Number of bytes sent in the lpBuffer parameter.
[in] lpBuffer
Label information. The format of this parameter depends on the value of the labelType parameter.
This function returns one of the following values.
Value | Meaning |
---|---|
|
Access to one or more RSM objects is denied. |
|
The database query or update failed. |
|
The value specified in the hSession parameter is not valid. |
|
Unable to retrieve the logical media definition from the database. |
|
Unable to retrieve the side definition from the database. |
|
The lpMediaId parameter is NULL. |
|
Unable to connect to the RSM service. |
|
The function was successful. |
The application updates RSM with the information supplied by the UpdateNtmsOmidInfo function and RSM verifies the information in the database. The label information is stored in the RSM database with the side associated with this LMID.
The UpdateNtmsOmidInfo function must be executed on the RSM server. Remote execution of this function results in an error.
For tape media lpBuffer must point to a buffer that holds the label just written on the tape. The data in this buffer is passed directly to the ClaimMediaLabel entry point of each MLL. One of the installed MLLs must recognize a valid label in this data.
For media with file systems, lpBuffer must be a pointer to a buffer that contains the following structure:
typedef struct {
WCHAR FileSystemType[64];
WCHAR VolumeName[256];
DWORD SerialNumber;
} NTMS_FILESYSTEM_INFO;
RSM uses this file system info as the OMID. The format utilities (LDM, explorer, format.com, and so on) effectively performs the same functionality as this call. An application that performs its own formatting or formats with a third-party file system type should only need to call UpdateNtmsOmidInfo for file system media.
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 |