PA_GetImportFilter

4D - Documentation   Français   English   German   4D Plugin API, Command Theme List   4D Plugin API, Command Alphabetical List   Back   Previous   Next

version 2003


PA_GetImportFilter char*

ParameterTypeDescription
This command does not require any parameters
Function resultchar*Pointer to the import ASCII map

Description

The routine PA_GetImportFilter returns pointer to the import ASCII map for the current process.

This pointer is valid until the process is terminated. There is one import ASCII map per process and by default, when a new process is started, the import ASCII map is set to the default map (each character is exported as is).

IMPORTANT NOTE:

The pointer returned is a pointer to a private data structure maintained for each process; therefore, do not attempt any Memory Manager calls using this pointer.

The import ASCII map for a process is used by 4th Dimension when:

Importing records using IMPORT TEXT, IMPORT DIF or IMPORT SYLK .

Reading or receive characters from a document or a serial port using RECEIVE PACKET .

Reading a serial port buffer using RECEIVE BUFFER.

This routine has two purposes:

The 4D Plug-in has text import capabilities and the import ASCII map is required inside those routines. To obtain the filtered ASCII code of a character get the value of the corresponding element from the array. If, for example, the filtered ASCII code of the character whose ASCII code is 225 is needed, read the value of the 225th element from the table whose pointer is returned.

The 4D Plug-in provides import ASCII map editing capabilities. To map a character to another, simply change the value of the corresponding element. For example, to change the filtered ASCII code of the character whose ASCII code is 225, change the value of the 225th element from the table whose pointer is returned.

See Also

PA_GetExportFilter, USE ASCII MAP.

Error Handling

PA_GetLastError always returns eER_NoErr


4D - Documentation   Français   English   German   4D Plugin API, Command Theme List   4D Plugin API, Command Alphabetical List   Back   Previous   Next