Edit

Share via

StringGetter function (d2d1effecthelpers.h)

  • Article

Calls a member-function property getter callback for a string-type property.

Syntax

HRESULT StringGetter(
  [in]            const IUnknown *effect,
  [out, optional] BYTE           *data,
                  UINT32         dataSize,
  [out, optional] UINT32         *actualSize
);

Parameters

[in] effect

Type: const IUnknown*

The effect with the property.

[out, optional] data

Type: BYTE*

When this method returns, contains a pointer to the data requested.

dataSize

Type: UINT32

The number of bytes in the data to be retrieved.

[out, optional] actualSize

Type: UINT32*

The actual size of the data, if the data is not measured in bytes.

Return value

Type: HRESULT CALLBACK

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

Requirements

Requirement Value
Target Platform Windows
Header d2d1effecthelpers.h
Library D2d1.lib
DLL D2d1.dll