SmDmsWorkflowPostprocess()

Programming Guides › Programming Guide for C › DMS Workflow API › Write and Define a DMS Workflow › SmDmsWorkflowPostprocess()

SmDmsWorkflowPostprocess()

SiteMinder calls this function so that a workflow library can postprocess a DMS event.

Syntax

Sm_DmsWorkflowApi_Status_t SM_EXTERN SmDmsWorkflowPostprocess(
   const Sm_Api_Context_t*            lpApiContext,  
   const Sm_Api_DmsContext_t*         lpDmsContext,
   const char *                       lpszWorkflowOid,
   const int                          nCategoryId,
   const int                          nEventId,
   const char *                       lpszObjectPath,
   const int                          nAttributes,
   const Sm_DmsWorkflow_Attribute_t*  pAttributes,
   const int                          nBytesErrMsg,
   char *                             lpszErrMsg
);

Parameter	I/O	Description
lpApiContext	I	Pointer to the API context structure.
lpDmsContext	I	Pointer to the DMS context structure.
lpszWorkflowOid	I	Unique workflow identifier.
nCategoryId	I	DMS event category.
nEventId	I	DMS event identifier
lpszObjectPath	I	Distinguished name of the object that is the target of this event, if any. The target object DN will be available for requests to create, delete, and modify directory objects.
nAttributes	I	Number of attributes in the array of response attributes.
pAttributes	I	Array of DMS response attribute/value pairs.
nBytesErrMsg	I	Maximum size of the output error buffer.
lpszErrMsg	O	Output buffer to receive the error text. Use this buffer to return an error message to the DMS application.

Returns

Sm_DmsWorkflowApi_Success. Function was successful.
Sm_DmsWorkflowApi_Failure. Function was not successful.
Sm_DmsWorkflowApi_Ignore. The event was of no interest to this step.

Remarks

The event has already been processed. Return values of Sm_DmsWorkflowApi_Success or Sm_DmsWorkflowApi_Ignore result in a success status returned to the application. Sm_DmsWorkflowApi_Failure causes an error code to be returned to the application. The error code indicates that there was a failure in the DMS postprocessing step.

The character array lpszErrMsg may be used by the postprocess function to send an error message back to the application. The maximum size of the character array is specified in nBytesErrMsg.

Email CA about this topic