SetNtmsObjectAttributeA 函数 (ntmsapi.h)

  • 项目

[从 Windows 7 和 Windows Server 2008 R2 起，可移动存储管理器 不再可用。]

SetNtmsObjectAttribute 函数在指定的 RSM 对象中创建名为 private data) (扩展属性。

语法

DWORD SetNtmsObjectAttributeA(
  [in] HANDLE      hSession,
  [in] LPNTMS_GUID lpObjectId,
  [in] DWORD       dwType,
  [in] LPCSTR      lpAttributeName,
  [in] LPVOID      lpAttributeData,
  [in] DWORD       dwAttributeSize
);

参数

[in] hSession

OpenNtmsSession 函数返回的会话的句柄。

[in] lpObjectId

要为其创建扩展属性的 RSM 对象的 GUID。

[in] dwType

RSM 对象类型。 有关对象类型的列表，请参阅 NtmsObjectsTypes。

[in] lpAttributeName

要创建的扩展属性的名称。

[in] lpAttributeData

用户定义的数据。

[in] dwAttributeSize

lpAttributeData 缓冲区的大小（以字节为单位）。

返回值

此函数返回以下值之一。

值 含义
ERROR_ACCESS_DENIED
 拒绝对对象NTMS_MODIFY_ACCESS，或者不允许对指定对象类型进行任何修改 (请参阅备注) 。 其他安全错误也可能存在，但它们表示存在安全子系统错误。

Windowsxp： 无需任何访问权限。
ERROR_DATABASE_FAILURE
 数据库更新失败。
ERROR_INVALID_HANDLE
 hSession 参数中指定的值为 NULL 或无效。
ERROR_INVALID_NAME
 名称或属性无效。 NTMS_MAXATTR_NAMELEN值定义最大属性名称长度。 长度包括 NULL。
ERROR_INVALID_PARAMETER
 指针为 NULL 或无效。
ERROR_NO_DATA
 指定的属性大于或等于 NTMS_MAXATTR_LENGTH。
ERROR_NOT_CONNECTED
 无法连接到 RSM 服务。
ERROR_OBJECT_NOT_FOUND
 GUID 无效。
ERROR_SUCCESS
 函数成功。

注解

必须在指定的 RSM 服务器上执行 SetNtmsObjectAttribute 函数。 由于字节缓冲区在不同体系结构的系统之间未分配，因此远程执行此函数可能会导致不可预知的结果。

若要删除属性，请执行一组长度为零的属性。

下面是需要特殊访问权限的对象列表。

Object Access
NTMS_CHANGER 需要NTMS_MODIFY_ACCESS库。
NTMS_CHANGER_TYPE 需要NTMS_MODIFY_ACCESS到计算机。
NTMS_COMPUTER 需要NTMS_MODIFY_ACCESS到计算机。
NTMS_DRIVE 需要NTMS_MODIFY_ACCESS库。
NTMS_DRIVE_TYPE 需要NTMS_MODIFY_ACCESS到计算机。
NTMS_IEDOOR 需要NTMS_MODIFY_ACCESS库。
NTMS_IEPORT 需要NTMS_MODIFY_ACCESS库。
NTMS_LIBRARY 需要NTMS_MODIFY_ACCESS库。
NTMS_LIBREQUEST 需要NTMS_MODIFY_ACCESS库。
NTMS_LOGICAL_MEDIA 需要NTMS_MODIFY_ACCESS逻辑媒体的媒体池。
NTMS_MEDIA_POOL 需要NTMS_MODIFY_ACCESS媒体池。
NTMS_MEDIA_TYPE 需要NTMS_MODIFY_ACCESS到计算机。
NTMS_OPREQUEST 需要NTMS_MODIFY_ACCESS到计算机。
NTMS_PARTITION 需要NTMS_MODIFY_ACCESS一侧的媒体池。
NTMS_PHYSICAL_MEDIA 需要NTMS_MODIFY_ACCESS媒体池。
NTMS_STORAGESLOT 需要NTMS_MODIFY_ACCESS库。
 

注意

ntmsapi.h 标头将 SetNtmsObjectAttribute 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。 有关详细信息，请参阅 函数原型的约定。

要求

要求 值
最低受支持的客户端 Windows XP [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 [仅限桌面应用]
目标平台 Windows
标头 ntmsapi.h
Library Ntmsapi.lib
DLL Ntmsapi.dll

另请参阅

EnumerateNtmsObject

GetNtmsObjectAttribute

对象管理功能