Provisioning Reference Guide › Common Program Exit Reference › Common Program Exit Structure › Common Exits DLL Interface

Common Exits DLL Interface

DLL deployed program exits must export the function with the following prototype:

int function_name(
   char	Input_XML,
   char *	Return_XML,
   int *	Return_Buffer_Length)

The following list describes the parameters for the DLL deployed program exit prototype:

• function_name

  Name of the program exit. One DLL can export multiple program exits, where each program exit is an exported function with the prototype defined above.

• InputXML

  Character buffer in UTF-8 format.It contains the XML buffer that the Provisioning Server passes to the program exit.

• ReturnXML

  Character buffer in UTF-8 format.,Iit is an empty buffer that the Provisioning Server passes to the program exit for it to send a return value back to the Provisioning Server. The size of the buffer is passed to the program exit is the Return_Buffer_Length parameter.

• Return_Buffer_Length

  Both an input and output parameter:

  • On input, Return_Buffer_Length indicates the maximum length, in characters, that the Return_XML buffer can contain. The program exits must not exceed this length when building the return XML buffer.
  • On output, Return_Buffer_Length contains the actual length of the return XML buffer the program exit built. That is, after the program exit builds the return XML buffer, it sets Return_Buffer_Length to the actual length of the buffer being returned.