GetNtmsObjectInformation

[This is preliminary documentation and subject to change.]

The GetNtmsObjectInformation function returns an object's information structure for the specified object.

DWORD WINAPI GetNtmsObjectInformation(
  HANDLE hSession,
  LPNTMS_GUID lpObjectId,
  LPNTMS_OBJECTINFORMATION lpInfo
);
 

Parameters

hSession

Handle to the session returned by the OpenNtmsSession function.

lpObjectId

Specifies a unique identifier of the RSM object.

lpInfo

Pointer to the NTMS_OBJECTINFORMATION structure.

Return values

ERROR_INVALID_HANDLE

The session handle is invalid or missing.

ERROR_INVALID_PARAMETER

The object ID or information structure is missing, or the object information size or object type is invalid.

ERROR_NOT_ENOUGH_MEMORY

An allocation failure occurred during processing.

ERROR_OBJECT_NOT_FOUND

The object ID is invalid.

ERROR_SUCCESS

The function was successful.

Remarks

The information size and type of the information structure must be set correctly in the lpInfo parameter before you use the GetNtmsObjectInformation function.

To avoid unpredictable results, applications must call the GetNtmsObjectInformation function before calling the SetNtmsObjectInformation function. The SetNtmsObjectInformation function updates all writable members of the NTMS_OBJECTINFORMATION structure, therefore the application is responsible for providing a value for all writable members.

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, GetNtmsObjectSecurity, NTMS_OBJECTINFORMATION, SetNtmsObjectInformation