IMAQdxEnumerateVideoModes

NI-IMAQdx Function Reference

IMAQdxEnumerateVideoModes

Format

rval = IMAQdxEnumerateVideoModes (IMAQdxSession id, IMAQdxVideoMode videoModeArray[], unsigned int *count, unsigned int *currentMode);

Purpose

Returns a list of video modes supported by the camera.

Note Note  This function applies only to cameras of bus type IMAQdxBusTypeFireWire. Use IMAQdxGetAttribute with attribute IMAQdxAttributeBusType to get your bus type.

If the number of video modes is not known in advance, complete the following steps:

  1. Call this function with the videoModeArray parameter set to NULL. The necessary size is then stored in videoModeArraySize.
  2. Allocate the videoModeArray with the given size.
  3. Call this function again using with the previously allocated array.

Parameters

Parameter Type Description
id IMAQdxSession A valid Session ID, which you can obtain using IMAQdxOpenCamera.
videoModeArray IMAQdxVideoMode [] Contains an array of video modes supported by the current camera. Set this parameter to NULL to get the size needed by the array in the count parameter.
count unsigned int (passed by reference) The size of the array used to store the video modes. If the user passes NULL as the videoModeArray parameter, this parameter then contains the needed size.
currentMode unsigned int (passed by reference) The index into the videoModeArray of the current mode used by the camera.

Return Value

On success, this function returns IMAQdxErrorSuccess. On failure, this function returns an error code. You can obtain a more detailed error message with IMAQdxGetErrorString.