PA_SendHTML

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

version 2003


PA_SendHTML (params; webData; HTMLbuffer; BufferLen)

ParameterTypeDescription
paramsPA_PluginParametersParameters received in PluginMain
webDatavoid*Pointer to any private object
HTMLbufferchar*Pointer to HTML data to send
BufferLenlongLength of the HTML buffer to send

Description

The command PA_SendHTML sends HTML that can represent your plug-in area when it is displayed by a browser. You can pass in webData any private data that can help you to dispose of the HTML buffer once 4D has finished using it. You will receive a eAE_WebDisposeData event telling you that 4D has finished using your HTML buffer and that you can now dispose of it.

params is the PA_PluginParameters the plug-in received in its PluginMain routine.

Example

   case eAE_WebPublish :
      webDataHandle:=PA_NewHandle(xxx);
      FillWebHandle(webDataHandle);
      buffer = PA_LockHandle( webDataHandle );
      len = PA_GetHandleSize(webDataHandle);
      PA_SendHTML( params, webDataHandle, buffer, len );
      // 4D will now get our buffer.. Do not touch the buffer until 4D has finished to send it
      break;

   case eAE_WebDisposeData :
      // 4D has now finished to send our HTML buffer
      // We get back our reference in order to dispose the buffer
      webDataHandle = (PA_Handle) PA_GetWebDataToDispose(params);
      PA_UnlockHandle( webDataHandle );
      PA_DisposeHandle( webDataHandle );
      break;

See Also

PA_GetWebDataToDispose.

Error Handling

eER_BadEventCall if not called during eAE_WebPublish event


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