GetNtmsObjectSecurity

[This is preliminary documentation and subject to change.]

The GetNtmsObjectSecurity function reads the security descriptor for the specified RSM object.

DWORD WINAPI GetNtmsObjectSecurity(
  HANDLE hSession,
  LPNTMS_GUID lpObjectId,
  DWORD dwType,
  SECURITY_INFORMATION RequestedInformation,
  PSECURITY_DESCRIPTOR lpSecurityDescriptor,
  DWORD nLength,
  LPDWORD lpnLengthNeeded
);
 

Parameters

hSession

Handle to the session returned by the OpenNtmsSession function.

lpObjectId

Specifies the unique identifier of the RSM object.

dwType

Specifies the object type. (See the EnumerateNtmsObject function for object types.)

RequestedInformation

Specifies the Windows NT security data.

lpSecurityDescriptor

Specifies the Windows NT security descriptor.

nlength

Specifies the length of the descriptor.

lpnLengthNeeded

Specifies the required length if the supplied buffer is not large enough for the security descriptor.

Return Values

ERROR_DATABASE_FAILURE

The database is inaccessible or damaged.

ERROR_INVALID_HANDLE

The session handle is invalid or missing.

ERROR_INVALID_PARAMETER

The object ID is missing.

ERROR_NO_SECURITY_ON_OBJECT

There is no security information for this object.

ERROR_OBJECT_NOT_FOUND

The object ID is invalid.

ERROR_SUCCESS

The function was successful.

Remarks

RSM security uses the same security descriptors and information members that Windows NT security uses. This allows the standard security dialog boxes to be used to select RSM security.

For more information on Windows NT security, see the SetPrivateObjectSecurity function and the security section in the Platform SDK. For more information on RSM security, see RSM Security.

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in ntmsapi.h.
  Import Library: Use ntmsapi.lib.

See Also

Object Management Functions, EnumerateNtmsObject, SetNtmsObjectSecurity