IMAQ1394 Get Image

NI-IMAQ for IEEE 1394 Cameras VI

previous page next page

IMAQ1394 Get Image

Acquires the specified frame into Image Out. Call this VI only after calling IMAQ1394 Configure Acquisition and IMAQ1394 Start Acquisition. If the type does not match the video format of the camera, this VI changes the image type to a suitable format.

IMAQ1394 Session In is a unique reference to the camera, which you can obtain with IMAQ1394 Init.
Image In is the reference to the image that receives the captured pixel data.
Buffer Number In is the cumulative image number to get. A value of -1 gets the most recently acquired buffer. A value of -2 gets the last acquired buffer.
error in (no error) is a cluster that describes the error status before this VI executes. If error in indicates that an error occurred before this VI was called, this VI may choose not to execute its function, but just pass the error through to its error out cluster. If no error has occurred, then this VI executes normally and sets its own error status in error out. Use the error handler VIs to look up the error code and to display the corresponding error message. Using the error in and error out clusters is a convenient way to check errors and to specify execution order by wiring the error output from one subVI to the error input of the next.
status is TRUE if an error occurred before this VI was called, or FALSE if not. If status is TRUE, code is a nonzero error code. If status is FALSE, code is zero or a warning code.

code is a number identifying an error or warning. If status is TRUE, code is a nonzero error code. If status is FALSE, code is zero or a warning code. Use the error handler VIs to look up the meaning of this code and display the corresponding error message.

source is a string that indicates the origin of the error, if any. Typically, source is the name of the VI in which the error occurred.

Overwrite Mode is the overwrite policy to follow if an image is overwritten during acquisition. Specify Get Oldest to get the oldest valid buffer instead of the overwritten buffer. Specify Fail to return an error if the requested buffer is overwritten. Specify Get Newest to get the most recent valid buffer instead of the overwritten buffer.
Note  The Get Next Iteration policy is not implemented by NI-IMAQ for IEEE 1394 Cameras and is presented only to keep the API consistent with NI-IMAQ 3.x.
IMAQ1394 Session Out is a unique reference to the camera. IMAQ1394 Session Out is the same as IMAQ1394 Session In.
Image Out is the reference to the captured image.
Buffer Number Out is the actual acquired buffer number returned.
error out is a cluster that describes the error status after this VI executes. If an error occurred before this VI was called, error out is the same as error in. Otherwise, error out shows the error, if any, that occurred in this VI. Use the error handler VIs to look up the error code and to display the corresponding error message. Using error in and error out clusters is a convenient way to check errors and to specify execution order by wiring the error output from one subVI to the error input of the next.
status is TRUE if an error occurred, or FALSE if not. If status is TRUE, code is a nonzero error code. If status is FALSE, code is zero or a warning code.

code is a number identifying an error or warning. If status is TRUE, code is a nonzero error code. If status is FALSE, code is zero or a warning code. Use the error handler VIs to look up the meaning of this code and display the corresponding error message.

source is a string that indicates the origin of the error, if any. Typically, source is the name of the VI in which the error occurred.

Note  Refer to Error Handling for error input and output information and error codes.
previous page start next page