SetNtmsObjectAttributeA function (ntmsapi.h)
[Removable Storage Manager is no longer available as of Windows 7 and Windows Server 2008 R2.]
The SetNtmsObjectAttribute function creates an extended attribute (named private data) in the specified RSM object.
Syntax
DWORD SetNtmsObjectAttributeA(
[in] HANDLE hSession,
[in] LPNTMS_GUID lpObjectId,
[in] DWORD dwType,
[in] LPCSTR lpAttributeName,
[in] LPVOID lpAttributeData,
[in] DWORD dwAttributeSize
);
Parameters
[in] hSession
Handle to the session returned by the OpenNtmsSession function.
[in] lpObjectId
GUID of the RSM object for which the extended attribute is to be created.
[in] dwType
RSM object type. For a list of object types, see NtmsObjectsTypes.
[in] lpAttributeName
Name of the extended attribute to be created.
[in] lpAttributeData
User-defined data.
[in] dwAttributeSize
Size of the lpAttributeData buffer, in bytes.
Return value
This function returns one of the following values.
| Value | Meaning |
|---|---|
|
NTMS_MODIFY_ACCESS is denied to the object or no modifications are allowed for the specified object type (see Remarks). Other security errors are also possible, but they would indicate a security subsystem error.
Windows XP: No access rights are required. |
|
The database update failed. |
|
The value specified in the hSession parameter is NULL or is not valid. |
|
The name or attribute is not valid. The NTMS_MAXATTR_NAMELEN value defines the maximum attribute name length. The length includes a NULL. |
|
The pointer is NULL or is not valid. |
|
The attribute specified is greater than or equal to NTMS_MAXATTR_LENGTH. |
|
Unable to connect to the RSM service. |
|
The GUID is not valid. |
|
The function was successful. |
Remarks
The SetNtmsObjectAttribute function must be executed on the specified RSM server. Because the buffer of bytes is unmarshaled between systems of different architectures, remote execution of this function can result in unpredictable results.
To delete an attribute, perform a set of the attribute with a length of zero.
The following is the list of objects that require special access rights.
| Object | Access |
|---|---|
| NTMS_CHANGER | Requires NTMS_MODIFY_ACCESS to the library. |
| NTMS_CHANGER_TYPE | Requires NTMS_MODIFY_ACCESS to the computer. |
| NTMS_COMPUTER | Requires NTMS_MODIFY_ACCESS to the computer. |
| NTMS_DRIVE | Requires NTMS_MODIFY_ACCESS to the library. |
| NTMS_DRIVE_TYPE | Requires NTMS_MODIFY_ACCESS to the computer. |
| NTMS_IEDOOR | Requires NTMS_MODIFY_ACCESS to the library. |
| NTMS_IEPORT | Requires NTMS_MODIFY_ACCESS to the library. |
| NTMS_LIBRARY | Requires NTMS_MODIFY_ACCESS to the library. |
| NTMS_LIBREQUEST | Requires NTMS_MODIFY_ACCESS to the library. |
| NTMS_LOGICAL_MEDIA | Requires NTMS_MODIFY_ACCESS to the media pool of the logical media. |
| NTMS_MEDIA_POOL | Requires NTMS_MODIFY_ACCESS to the media pool. |
| NTMS_MEDIA_TYPE | Requires NTMS_MODIFY_ACCESS to the computer. |
| NTMS_OPREQUEST | Requires NTMS_MODIFY_ACCESS to the computer. |
| NTMS_PARTITION | Requires NTMS_MODIFY_ACCESS to the media pool of the side. |
| NTMS_PHYSICAL_MEDIA | Requires NTMS_MODIFY_ACCESS to the media pool. |
| NTMS_STORAGESLOT | Requires NTMS_MODIFY_ACCESS to the library. |
Note
The ntmsapi.h header defines SetNtmsObjectAttribute as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
Requirements
| 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 |