WGrammar Grammar Checker Engine - Support

Home Site index Contact us Catalog Shopping Cart Products Support Search

You are here: Home > Support > WGrammar Grammar Checker Engine > Using WGrammar Windows SDK with PowerBuilder

Using WGrammar Windows SDK with PowerBuilder

Product: WGrammar Grammar Checker Engine Windows SDK

The following declarations may help customers who need to integrate WGrammar Grammar Checker Engine into a PowerBuilder application.

Function declarations

WGrammar API functions documented in WGrammar Reference Guide are shown in C/C++ syntax. The following table shows how to translate C/C++ data types into PowerBuilder data types:

C/C++ type	Type description	C/C++ example	Equivalent PowerBuilder type	PowerBuilder Example
char *	String, or more accurately, pointer to an array of characters	char *fileName	ref String	ref String fileName
WS_S16	Signed, 16-bit integer	WS_S16 sid	integer	integer sid
WS_S32	Signed, 32-bit integer	WS_S32 offset	long	long offset
WS_S32 *	Pointer to a signed, 32-bit integer ("pointer" meaning "pass by reference")	WS_S32 *matchOffset	ref long	ref long matchOffset

For pointer-type parameters (denoted by "*", as in char *str) the keyword "const" indicates that the parameter is passed by reference but will not be modified by the called function. If "const" is missing, the parameter is either an output parameter (meaning it is modified to by the called function) or an input/output parameter (meaning its value is read by the called function and may be modified by the called function). PowerBuilder has no equivalent, so the "const" keyword can be omitted, but you should be aware of its meaning.

Following is an example function declaration:

FUNCTION LONG WGrammar_Run(integer sid, ref long matchOffset, ref long matchLen, ref string description, long descriptionSz, ref string replacement, long replacementSz, ref string id, long idSz, ref long confidence) library "WGRAM232.DLL"

(Note that references to WGRAM232.DLL should be changed to the name of the WGrammar DLL included with your version of the WGrammar Windows SDK.)