NWUXGetScanAction

Returns the status of current scan/parse functions

Local Servers:nonblocking
Remote Servers:N/A
NetWare Server:4.x, 5.x, 6.x
Platform:NLM, Windows NT, Windows95, Windows 98
Library:Cross-Platform Localization (LOC*.*)
Service:Unicode

Syntax

   #include <nunicode.h> 
    
   N_EXTERN_LIBRARY(nint) NWUXGetScanAction  ( 
      pCONVERT   byteUniHandle,  
      pnint      scanByteAction,  
      pnint      scanUniAction);
   

Pascal Syntax

   uses netwin32 
    
   Function NWUXGetScanAction 
     (byteUniHandle : pCONVERT;
     scanByteByteAction : pnint;
     scanUniAction : pnint              
   ): nint;
   

Parameters

byteUniHandle
(IN) Points to the converter handle.
scanByteAction
(OUT) Points to the status of current byte scan/parse functions (optional, set to NULL if not needed).
scanUniAction
(OUT) Points to the status for current Unicode scan/parse functions (optional, set to NULL if not needed).

Return Values

0x0000

SUCCESSFUL

0xFDE9

NWU_NULL_HANDLE

0xFDEA

NWU_BAD_HANDLE

0xFDEB

NWU_HANDLE_MISMATCH

0xFDED

NWU_RANGE_ERROR

Remarks

The scanByteAction and scanUniAction parameters return one of the following values:

NWU_ENABLED

Scan/parse functions are enabled

NWU_DISABLED

Scan/parse functions are disabled

The default state of the scanByteAction parameter is NWU_DISABLED after a converter is initialized.

The default state of the scanUniAction parameter is NWU_ENABLED.

See exgscan.c for sample code.

See Also

NWUXSetScanAction, NWUXGetByteFunctions, NWUXGetUniFunctions