Skip to content

Latest commit

 

History

History
236 lines (193 loc) · 5.78 KB

nf-ntmsapi-updatentmsomidinfo.md

File metadata and controls

236 lines (193 loc) · 5.78 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:ntmsapi.UpdateNtmsOmidInfo
UpdateNtmsOmidInfo function (ntmsapi.h)
The UpdateNtmsOmidInfo function updates the RSM database with label information immediately after writing to the newly allocated medium.
NTMS_OMID_TYPE_FILESYSTEM_INFO
NTMS_OMID_TYPE_RAW_LABEL
UpdateNtmsOmidInfo
UpdateNtmsOmidInfo function [Files]
_zaw_updatentmsomidinfo
base.updatentmsomidinfo
fs.updatentmsomidinfo
ntmsapi/UpdateNtmsOmidInfo
fs\updatentmsomidinfo.htm
fs
2e154005-a14c-4de6-aec5-f30b934c64a2
12/05/2018
NTMS_OMID_TYPE_FILESYSTEM_INFO, NTMS_OMID_TYPE_RAW_LABEL, UpdateNtmsOmidInfo, UpdateNtmsOmidInfo function [Files], _zaw_updatentmsomidinfo, base.updatentmsomidinfo, fs.updatentmsomidinfo, ntmsapi/UpdateNtmsOmidInfo
ntmsapi.h
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
Ntmsapi.lib
Ntmsapi.dll
Windows
19H1
UpdateNtmsOmidInfo
ntmsapi/UpdateNtmsOmidInfo
c++
APIRef
kbSyntax
DllExport
Ntmsapi.dll
UpdateNtmsOmidInfo

UpdateNtmsOmidInfo function

-description

[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.

-parameters

-param hSession [in]

Handle to the session returned by the OpenNtmsSession function.

-param lpMediaId [in]

Unique identifier of a piece of logical media.

-param labelType [in]

Label type. This parameter can be one of the following values.

Value Meaning
NTMS_OMID_TYPE_FILESYSTEM_INFO
The lpBuffer parameter contains an NTMS_FILESYSTEM_INFO structure. This flag is used for media that contain file systems.
NTMS_OMID_TYPE_RAW_LABEL
The lpBuffer parameter contains the raw bytes of the application label. This flag is used for media that contain application written labels.

-param numberOfBytes [in]

Number of bytes sent in the lpBuffer parameter.

-param lpBuffer [in]

Label information. The format of this parameter depends on the value of the labelType parameter.

-returns

This function returns one of the following values.

Value Meaning
ERROR_ACCESS_DENIED
Access to one or more RSM objects is denied.
ERROR_DATABASE_FAILURE
The database query or update failed.
ERROR_INVALID_HANDLE
The value specified in the hSession parameter is not valid.
ERROR_INVALID_MEDIA
Unable to retrieve the logical media definition from the database.
ERROR_INVALID_PARTITION
Unable to retrieve the side definition from the database.
ERROR_INVALID_PARAMETER
The lpMediaId parameter is NULL.
ERROR_NOT_CONNECTED
Unable to connect to the RSM service.
ERROR_SUCCESS
The function was successful.

-remarks

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.

-see-also

On-Media-Identifier Management Functions