PA_ClearVariable

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

version 2003


PA_ClearVariable (aVariable)

ParameterTypeDescription
aVariablePA_Variable *Pointer to the variable to clear

Description

The routine PA_ClearVariable clear the variable pointed to by aVariable, and all its content (data of text, BLOB and picture variables).

After the call, the kind of the variable pointed to by aVariable is set to eVK_Undefined, and the variable can be re-initialized to another kind (PA_CreateVariable, PA_SetxxxVariable).

IMPORTANT NOTE

Do NOT dispose of a variable that belongs to 4th Dimension after a call to PA_GetVariable ie.

Example

Create, use, and dispose of a longint array

   PA_Variable arr;
   arr = PA_CreateVariable(eVK_ArrayLongint, 0);
   PA_SetArrayNbElements(arr, 100);// make an array of 100 elements
   /* . . . do something with this array . . . */
   // Cleanup
   PA_CearVariable(&arr); 

See Also

No reference.

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