Edit

Share via

AcxStreamGetElementById function (acxstreams.h)

  • Article

The AcxStreamGetElementById function returns the ACXELEMENT Object handle for the requested element ID. For more information about ACX Objects, see ACX - Summary of ACX Objects.

Syntax

ACXELEMENT AcxStreamGetElementById(
  ACXSTREAM Stream,
  ULONG     ElementId
);

Parameters

Stream

An existing ACXSTREAM Object. An ACXSTREAM object represents an audio stream created by a circuit.

ElementId

The Id of the requested element.

Return value

The ACXELEMENT Object handle of the requested element, or NULL if the ACXSTREAM doesn't have an ACXELEMENT with the given Id.

Remarks

Example

Example usage is shown below.

    ULONGLONG               index       = GetMessageContext(Event); // Context is an index.
    ACXELEMENT              element     = nullptr;
    //
    // Get the ACX element.
    //
    element = AcxStreamGetElementById(Stream, (ULONG)index);

ACX requirements

Minimum ACX version: 1.0

For more information about ACX versions, see ACX version overview.

Requirements

Requirement Value
Header acxstreams.h
IRQL <= DISPATCH_LEVEL

See also