Edit

Share via

IDMLObject::GetPrivateData method (directml.h)

  • Article

Gets application-defined data from a DirectML device object. This method is thread-safe.

Syntax

HRESULT GetPrivateData(
  [in]            REFGUID guid,
  [in, out]       UINT    *dataSize,
  [out, optional] void    *data
);

Parameters

[in] guid

Type: REFGUID

The GUID that is associated with the data.

[in, out] dataSize

Type: UINT*

A pointer to a variable that on input contains the size, in bytes, of the buffer that data points to, and on output contains the size, in bytes, of the amount of data that GetPrivateData retrieved.

[out, optional] data

Type: void*

A pointer to a memory block that receives the data from the device object if dataSize points to a value that specifies a buffer large enough to hold the data.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

If the data returned is a pointer to an IUnknown (or derived interface) that was previously set by SetPrivateDataInterface, then that interface will have its reference count incremented before the private data is returned.

Requirements

Requirement Value
Target Platform Windows
Header directml.h
Library DirectML.lib
DLL DirectML.dll

See also

IDMLObject