Jump to content

SplQpQueryDt: Difference between revisions

From EDM2
Created page with "SplQpQueryDt returns a list of supported data types. ==Syntax== SplQpQueryDt(pcDatatypes, papszDatatypes); ==Parameters== ; pcDatatypes (PLONG) - input : A pointer to a va..."
 
Ak120 (talk | contribs)
mNo edit summary
 
Line 1: Line 1:
SplQpQueryDt returns a list of supported data types.  
SplQpQueryDt returns a list of supported data types.
 
==Syntax==
==Syntax==
  SplQpQueryDt(pcDatatypes, papszDatatypes);
SplQpQueryDt(pcDatatypes, papszDatatypes)
 
==Parameters==
==Parameters==
; pcDatatypes (PLONG) - input  
; pcDatatypes (PLONG) - input: A pointer to a value indicating the maximum number of data types. On return, the value is updated to show the number of data types returned.
: A pointer to a value indicating the maximum number of data types. On return, the value is updated to show the number of data types returned.  
; papszDatatypes (PSZ) - input: A pointer to an array of pointers that address the locations for the returned data type names. Each location must be an array of 16 characters to accommodate a name of the maximum length with its terminating NULL.


; papszDatatypes (PSZ) - input
: A pointer to an array of pointers that address the locations for the returned data type names. Each location must be an array of 16 characters to accommodate a name of the maximum length with its terminating NULL.
==Return Code==
==Return Code==
; fSuccess (BOOL) - returns  
; fSuccess (BOOL) - returns: Return codes.
: Return codes.  


On completion, the handling routine must return BOOLEAN (fSuccess).  
On completion, the handling routine must return BOOLEAN (fSuccess).
* TRUE Success  
* TRUE Success
* FALSE Error  
* FALSE Error


==Remarks==
==Remarks==
This function should be called once with pcDatatypes set to 0 to determine the number of data types. The array papszDatatypes is not updated in this instance. The application can then allocate storage for the array and call the function a second time to return a list of supported data types.  
This function should be called once with pcDatatypes set to 0 to determine the number of data types. The array papszDatatypes is not updated in this instance. The application can then allocate storage for the array and call the function a second time to return a list of supported data types.
 
==Example Code==
==Example Code==
<PRE>
<PRE>

Latest revision as of 20:04, 2 July 2023

SplQpQueryDt returns a list of supported data types.

Syntax

SplQpQueryDt(pcDatatypes, papszDatatypes)

Parameters

pcDatatypes (PLONG) - input
A pointer to a value indicating the maximum number of data types. On return, the value is updated to show the number of data types returned.
papszDatatypes (PSZ) - input
A pointer to an array of pointers that address the locations for the returned data type names. Each location must be an array of 16 characters to accommodate a name of the maximum length with its terminating NULL.

Return Code

fSuccess (BOOL) - returns
Return codes.

On completion, the handling routine must return BOOLEAN (fSuccess).

  • TRUE Success
  • FALSE Error

Remarks

This function should be called once with pcDatatypes set to 0 to determine the number of data types. The array papszDatatypes is not updated in this instance. The application can then allocate storage for the array and call the function a second time to return a list of supported data types.

Example Code

#include <os2.h>

PLONG    pcDatatypes;
PSZ      papszDatatypes;
BOOL     fSuccess;        /*  Return codes. */

fSuccess = SplQpQueryDt(pcDatatypes, papszDatatypes);