opcif_get_pipe()

   #include opcapi.h

   int opcif_get_pipe(
                    int       interface_id,       /* in */
                    int       pipefd              /* out */
                     );

Parameters

interface_id

Specifies which interface instance is used.

pipefd

Returns the file descriptor of the selected output interface queue.

Description

A program reading from several input files needs the pipe file descriptor of its interface input queue. This descriptor is then used as part of the parameters to select(2) or fcntl(2). The function opcif_get_pipe() returns this value.

For convenience reasons, an application that reads only from the HPOM interface can specify OPCIF_READ_WAIT in the opcif_open() call.

Return Values

OPC_ERR_OK

OK.

OPC_ERR_CANT_INIT

Initialization of queues failed.

OPC_ERR_INVALID_OUTPARAM

pipefd is NULL.

OPC_ERR_INVALID_INTERFACE_ID

No such interface opened.

Versions

HPOM for Windows 8.00 and higher