Functions and Directives Functions and Directives

Function _conGetL() Foundation

Copies the value of a logical container into a buffer.

Syntax
XPPAPIRET _conGetL(ContainerHandle chl, BOOL *lValue);
Parameters
ContainerHandle chl
Handle of a container with a logical value
BOOL *lValue
Pointer to a BOOL buffer into which the logical value of the container is to be written.
Return

The function returns an error code (XPP_ERR_...) when the container chl is not of logical type. If the return value is NULL the operation was successful.

Description

_conGetL() accesses the value of a logical container. The parameter *lValue contains TRUE (= 1) or FALSE (= 0) after the call. If the function returns an error the passed buffer is not changed.

Examples
/* 
Reads a logical value and outputs a response to <stdout> 
*/ 
#include <xppcon.h> 
#include <stdio.h> 

ContainerHandle  hLogic; 
XPPAPIRET        xr; 
BOOL             logic; 


/* Assigns a value to ... hLogic */ 

xr = _conGetL(hLogic, &logic); 
if (xr == 0) 
{ 
if (logic == 0) 
   printf("Incorrect\n"); 
else /* logic == 1 */ 
   printf("Correct\n"); 
}
Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.