Edit

EcGetSubscriptionProperty function (evcoll.h)

  • Article

The EcGetSubscriptionProperty function retrieves a specific property value from a subscription object. The subscription object is specified by the handle passed into the Subscription parameter.

Syntax

BOOL EcGetSubscriptionProperty(
  [in]  EC_HANDLE                   Subscription,
  [in]  EC_SUBSCRIPTION_PROPERTY_ID PropertyId,
  [in]  DWORD                       Flags,
  [in]  DWORD                       PropertyValueBufferSize,
  [in]  PEC_VARIANT                 PropertyValueBuffer,
  [out] PDWORD                      PropertyValueBufferUsed
);

Parameters

[in] Subscription

The handle to the subscription object.

[in] PropertyId

An identifier that specifies which property of the subscription to get. Specify a value from the EC_SUBSCRIPTION_PROPERTY_ID enumeration. If you specify the EcSubscriptionEventSources value, then a handle to an array (EC_OBJECT_ARRAY_PROPERTY_HANDLE) will be returned. You can then use the EcGetObjectArrayProperty and EcSetObjectArrayProperty functions to get and set the Address, Enabled, UserName, and Password properties in the array.

[in] Flags

Reserved. Must be NULL.

[in] PropertyValueBufferSize

The size of the user-supplied buffer to store the property value into.

[in] PropertyValueBuffer

The user-supplied buffer to store property value into.

[out] PropertyValueBufferUsed

The size of the user-supplied buffer that is used by the function on successful return, or the size that is necessary to store the property value when function fails with ERROR_INSUFFICIENT_BUFFER.

Return value

This function returns BOOL.

Requirements

Requirement Value
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Target Platform Windows
Header evcoll.h
Library Wecapi.lib
DLL Wecapi.dll

See also

Windows Event Collector Functions