The Workflow Management Coalition Specification
Workflow Management Coalition
Workflow Client Application (Interface 2)
Application Programming Interface
(WAPI)
Naming Conventions
Document Number WFMC-TC-1013
15-May-96
Version 1.1
Workflow Management Coalition
Avenue Marcel Thiry 204
1200 Brussels
Belgium
Tel: +32 2 774 96 33
Fax: +32 2 774 96 90
Email: 100113.1555@compuserve.com
or WfMC@eyam.be
www: http://www.aiai.ed.ac.uk/wfmc
or http://www.arms.ohio-state.edu/wfmc
The "WfMC" logo and "Workflow Management Coalition" name are service marks of
the Workflow Management Coalition.
Neither the Workflow Management Coalition nor any of its members make any
warranty of any kind whatsoever, express or implied, with respect to the
Specification, including as to non-infringement, merchantability or fitness for
a particular purpose. This Specification is provided "as is".
First printing, November 1995
Second printing, version 1.1, May 1996
- readability
- portability
- usability
- compile time name space resolution
- link time name space resolution
- implementation
Readability
Naming conventions should be designed to facilitate readability. This can be
achieved by a number of simple steps. Using long symbol names that convey the
purpose of the symbol in the WAPI facilitates readability. Clearly separating
the words in symbol names by using underscores or capitalizing the first letter
of each word also improves readability.
The proposed naming convention spells out symbol words fully, and separates different words in the symbol name by capitalizing the first letter of each word.
Portability
Portability issues usually discourage designers from thinking about
readability. Some platforms allow only limited symbol name length, and usage
of characters in only one case. This in turn will make symbol names short,
encrypted, and discourage the use of underscores or capitalization to separate
the words in symbol names.
Most modern environments support symbol names of greater than 32 characters with at least 32 significant characters. These are the environments for which the current API set is most suitable.
The proposed solution should be carefully modified for improved portability. If deemed necessary the API would be modified specifically for those environments where symbol name lengths are restricted. This modification would start by identifying the set of platforms and operating systems supported by the coalition members, and then modifying the naming convention and the APIs to accommodate restrictions of each of those systems, trying to avoid sacrificing readability.
Usability
The WAPI naming convention should allow WAPI users to write applications that
can be linked against any vendor's library with minimal changes to the source
code. All WAPI calls are intended to be usable by all the prevalent
programming environments currently in use. Although the this convention is
biased toward `C' and `C++' users, the convention should allow the functions
implemented to be called by environments such as Visual Basic, Smalltalk, and
various 4GL and other environments.
The proposed solution requires all vendors to name the corresponding symbols with the same name. This will allow users to change WAPI vendor libraries without modifying the application source code.
The proposed solution assumes that the WAPI vendor libraries will be implemented as DLLs (dynamic linked libraries).
Compile
Time Name Space Resolution
Compile time name space issues can be resolved by reserving a prefix for all WAPI symbols. This prefix should be short, and each symbol should start with the prefix. In the case that a particular WAPI vendor or user has a conflict between a WAPI symbol name and an internal symbol name, compile time symbols can be easily re-mapped with the help of C preprocessor or by editing the header files. The naming conventions should be designed so that the need for such interventions is minimized.
This solution chooses `WM' as a prefix to all WAPI symbol names. Furthermore,
different classes of symbol names have an additional letter identifying the
class that the symbol belongs to, thus improving readability. For example, all
WAPI types start with `WMT'.
Link
Time Name Space Resolution
Unlike compile time symbols, conflicts between link time symbols, such as
multiple defined function names, are not easily correctable. Thus, the major
and most important goal of a successfully designed naming convention is to
minimize the chance of link time symbol conflicts. A well designed naming
convention will not only allow WAPI vendors and users to link WAPI against
their internal libraries without conflicts, but it will enable users to link
their applications against multiple vendor WAPIs at the same time as well.
This ought to be achieved without sacrificing usability. For example,
requiring that each vendor uses their own prefix before each WAPI function
would facilitate link time name space resolution by elimination of multiple
defined symbols between different vendors' functions linked into the same
executable, but at the same time it would decrease the usability of the WAPI,
since users would have to customize their application source code for each
vendor's WAPI separately.
Implementation
The proposed solution assumes that the coalition will provide a common header
file as a starting point for vendor implementations. This is a curtail step,
since the definition of a common WAPI programming vocabulary is essential for
usability issues, and at the same time it eliminates many possible
misinterpretations among different vendors.
Named
Entities
In general all of the named entities within the scope of the Workflow
Management Coalition specifications should have names which start with the
letters `WM'.
The sections to come will outline specific naming conventions for the following named entities:
Functions The callable routines specified by the WfMC APIs
Data Type Definitions The "typedefs" used to declare and create variables for the API
Variables The necessary variables required to support the APIs, i.e. parameters for those functions.
Structures The data structures required for passing information to and from the APIs
Files The files required to support the compilation and linking of programs
written with the APIs
Functions
All functions in the Workflow Management Coalition's API suite should be
preceded with the `WM' prefix. All functions should also return the
same return value as specified by the WMTErrRetType typedef. The following is
an example of a function declaration:
WMTErrRetType WMOpenProcessDefinitionsList (
in WMTPSessionHandle psession_handle,
in WMTPFilter pproc_def_filter,
in WMTBoolean count_flag,
out WMTPQueryHandle pquery_handle,
The basic data types from which all other types are derived are defined as follows:
WMTInt8 signed 8 bit value representation
WMTInt16 signed 16 bit value representation
WMTInt32 signed 32 bit value representation
WMTUInt8 unsigned 8 bit value representation
WMTUInt16 unsigned 16 bit value representation
WMTUInt32 unsigned 32 bit value representation
The convention for dealing with pointer "typedefs" will be to use the prefix `WMTP'. For example:
typedef *WMTConnectInfo WMTPConnectInfo;
Variables
Naming of variables in the API set should be descriptive but are not required
to have a special prefix. For variables which are pointers it is recommended
that `p' be used as a prefix. It is presumed that for those
environments that support multiple pointer dimensions that the pointers be
defined as the largest supported size, e.g. for Intel based compilers the "FAR"
pointer type will be used.
For variables which have a scope outside of a module, those variables should be
prefixed with `WMGV' to denote Workflow Management Global Variables.
For various reasons the use of global variables will be discouraged but this
document includes a naming specification for completeness.
Structures
Naming of structure typedefs should be done following the conventions already
given for data type definitions. Naming of the actual structures should follow
the conventions for naming variables.
Static
Defines
All static definitions required by the WfMC APIs such as Error Values should
have names beginning with `WM' and be all caps with underscores where
appropriate.
Files
All files required by the WfMC APIs such as `C' include files should have names
beginning with `WM' and be limited to 8 characters with appropriate 3
character extensions.
Include
Files & Examples
The following sections show the include files as defined to support the
Workflow Management Coalition APIs in general and the Interface 2 APIs
specifically. These files serve also as examples for the purpose of
illustrating the usage of the naming conventions described here in this document.
Include
File - wmbasic.h
File: wmbasic.h
1 2 3 4 5 6 7 8
1234567890123456789012345678901234567890123456789012345678901234567890123456790
/*
This file is provided by the vendor for each specific platform environment.
It contains definitions of the basic Workflow Management types that are operating system or platform dependent.
*/
#ifndef WMTBASIC_H
#define WMTBASIC_H
typedef char WMTInt8;
typedef short WMTInt16;
typedef long WMTInt32;
typedef unsigned char WMTUInt8;
typedef unsigned short WMTUInt16;
typedef unsigned long WMTUInt32;
/****************
WMTPointer - generic pointer representation, points to the smallest
addressable unit of information.
*/
typedef WMTUInt8 *WMTPointer;
#define WMNULL ((WMTPointer)0)
/****************
WMTText - since different vendors may represent textual information in
different formats for language independence purposes, we treat text as
an opaque generic pointer.
*/
typedef WMTInt8 WMTText;
typedef WMTText *WMTPText;
typedef WMTInt8 *WMTPInt8;
typedef WMTInt16 *WMTPInt16;
typedef WMTInt32 *WMTPInt32;
/*****************
WMTBoolean - boolean type and value definitions.
*/
typedef WMTInt8 WMTBoolean;
typedef WMTText *WMTPPrivate;
#define WMFalse 0
#define WMTrue (!WMFalse)
#define NAME_STRING_SIZE 64
#define UNIQUE_ID_SIZE 64
#endif
File: wmapi2.h
1 2 3 4 5 6 7 8
1234567890123456789012345678901234567890123456789012345678901234567890123456790
/*
WMAPI.H
This is the file supplied by the Workflow Management Coalition.
It contains standard parameters, function and value definitions.
*/
#ifndef WMAPI_H
#define WMAPI_H
/****************
WM* - all global Workflow Management symbols start with WM
WMT* - all type definitions start with WMT
*/
/****************
Basic Type Definitions:
Before including this file, the following types have to be type defined
by the vendor according to the current platform definitions. All other
WORKFLOW MANAGEMENT types are derived from these basic types.
WMTInt8 signed 8 bit value representation
WMTInt16 signed 16 bit value representation
WMTInt32 signed 32 bit value representation
WMTUInt8 unsigned 8 bit value representation
WMTUInt16 unsigned 16 bit value representation
WMTUInt32 unsigned 32 bit value representation
WMTPInt8 8 bit pointer value representation
WMTPInt16 16 bit pointer value representation
WMTPInt32 32 bit pointer value representation
*/
#include "wmtbasic.h"
/*****************************************************
This section defines all the structures used by the interface 2 API.
*/
/******************************************************
WMTErrRetType
*/
typedef struct {
WMTInt16 main_code;
WMTInt16 sub_code;
} WMTErrRetType;
/******************************************************
WMTConnectInfo
*/
typedef struct
{
WMTText user_identification[NAME_STRING_SIZE];
WMTText password[NAME_STRING_SIZE];
WMTText engine_name[NAME_STRING_SIZE];
WMTText scope[NAME_STRING_SIZE];
}WMTConnectInfo;
typedef WMTConnectInfo *WMTPConnectInfo;
/******************************************************
WMTSessionHandle
*/
typedef struct
{
WMTUInt32 session_id;
WMTPPrivate pprivate;
}WMTSessionHandle;
typedef WMTSessionHandle *WMTPSessionHandle;
/******************************************************
WMTFilter
*/
typedef struct
{
WMTInt32 filter_type;
WMTInt32 filter_length;
WMTText attribute_name [NAME_STRING_SIZE];
WMTUInt32 comparison;
WMTPText filter_string;
}WMTFilter;
typedef WMTFilter *WMTPFilter;
/** The first 255 filter types (0x00000001 to 0x000000FF) will be reserved. These will be used for filtering on attributes of process control data and process relevant data.
*/
/******************************************************
WMTQueryHandle
*/
typedef struct
{
WMTUInt32 query_handle;
}WMTQueryHandle;
typedef WMTQueryHandle *WMTPQueryHandle;
/******************************************************
WMTWflParticipant
*/
typedef struct
{
WMTText wf_participant[NAME_STRING_SIZE];
}WMTWflParticipant;
typedef WMTWflParticipant *WMTPWflParticipant;
/******************************************************
WMTProcDefID
*/
typedef struct
{
WMTText proc_def_id[UNIQUE_ID_SIZE];
}WMTProcDefID;
typedef WMTProcDefID *WMTPProcDefID;
/******************************************************
WMTActivityID
*/
typedef struct
{
WMTText activity_id[NAME_STRING_SIZE];
}WMTActivityID;
typedef WMTActivityID *WMTPActivityID;
/******************************************************
WMTProcDefState
*/
typedef struct
{
WMTText proc_def_state[NAME_STRING_SIZE];
} WMTProcDefState;
typedef WMTProcDefState *WMTPProcDefState;
/******************************************************
WMTProcDef
*/
typedef struct
{
WMTText process_name[NAME_STRING_SIZE];
WMTProcDefID proc_def_id;
WMTProcDefState state;
} WMTProcDef;
typedef WMTProcDef *WMTPProcDef;
/******************************************************
WMTProcInstID
*/
typedef struct
{
WMTText proc_inst_id[UNIQUE_ID_SIZE];
}WMTProcInstID;
typedef WMTProcInstID *WMTPProcInstID;
/******************************************************
WMTProcInstState
*/
typedef struct
{
WMTText proc_inst_state[NAME_STRING_SIZE];
} WMTProcInstState;
typedef WMTProcInstState *WMTPProcInstState;
/******************************************************
WMTProcInst
*/
typedef struct
{
WMTText process_name[NAME_STRING_SIZE];
WMTProcInstID proc_inst_id;
WMTProcDefID proc_def_id;
WMTProcInstState state;
WMTInt32 priority;
WMTWflParticipant proc_participants[20];
} WMTProcInst;
typedef WMTProcInst *WMTPProcInst;
/******************************************************
WMTActivityInstID
*/
typedef struct
{
WMTText activity_inst_id[UNIQUE_ID_SIZE];
} WMTActivityInstID;
typedef WMTActivityInstID *WMTPActivityInstID;
/******************************************************
WMTActivityInstState
*/
typedef struct
{
WMTText activity_inst_state[NAME_STRING_SIZE];
} WMTActivityInstState;
typedef WMTActivityInstState *WMTPActivityInstState;
/******************************************************
WMTActivityInst
*/
typedef struct
{
WMTText activity_name[NAME_STRING_SIZE];
WMTActivityInstID activity_inst_id;
WMTProcInstID proc_inst_id;
WMTActivityInstState state;
WMTInt32 priority;
WMTWflParticipant activity_participants[10];
} WMTActivityInst;
typedef WMTActivityInst *WMTPActivityInst;
/******************************************************
WMTWorkItemID
*/
typedef struct
{
WMTText work_item_id[UNIQUE_ID_SIZE];
} WMTWorkItemID;
typedef WMTWorkItemID *WMTPWorkItemID;
/******************************************************
WMTWorkItem
*/
typedef struct
{
WMTText workitem_name[NAME_STRING_SIZE];
WMTWorkItemID workitem_id;
WMTActivityInstID activity_inst_id;
WMTProcInstID proc_inst_id;
WMTInt32 priority;
WMTWflParticipant participant;
} WMTWorkItem;
typedef WMTWorkItem *WMTPWorkItem;
/******************************************************
WMTAttrName
*/
typedef WMTText WMTAttrName[NAME_STRING_SIZE];
typedef WMTAttrName *WMTPAttrName;
/*******************
WAPI - Interface 2 function declarations.
The definitions include specification of parameters with indication of the
direction of data passing:
in for parameters with data being passed to the API fuction
out for parameters with data being passed from the API function
*/
#define in
#define out
WMTErrRetType WMConnect (
in WMTPConnectInfo pconnect_info,
out WMTPSessionHandle psession_handle);
WMTErrRetType WMDisconnect (
in WMTPSessionHandle psession_handle);
WMTErrRetType WMOpenProcessDefinitionsList (
in WMTPSessionHandle psession_handle,
in WMTPFilter pproc_def_filter,
in WMTBoolean count_flag,
out WMTPQueryHandle pquery_handle,
out WMTPInt32 pcount);
WMTErrRetType WMFetchProcessDefinition (
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle,
out WMTPProcDef pproc_def_buf_ptr);
WMTErrRetType WMCloseProcessDefinitionList(
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle);
WMTErrRetType WMOpenProcessDefinitionStatesList (
in WMTPSessionHandle psession_handle,
in WMTPProcDefID pproc_def_id,
in WMTPFilter pproc_def_state_filter,
in WMTBoolean count_flag,
out WMTPQueryHandle pquery_handle,
out WMTUInt32 pcount);
WMTErrRetType WMFetchProcessDefinitionState (
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle,
out WMTPProcDefState pproc_def_state);
WMTErrRetType WMCloseProcessDefinitionStatesList (
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle);
WMTErrRetType WMChangeProcessDefinitionState (
in WMTPSessionHandle psession_handle,
in WMTPProcDefID pproc_def_id,
in WMTPProcDefState pproc_def_state);
WMTErrRetType WMCreateProcessInstance (
in WMTPSessionHandle psession_handle,
in WMTPProcDefID pproc_def_id,
in WMTPText pproc_inst_name,
out WMTPProcInstID pproc_inst_id);
WMTErrRetType WMStartProcess (
in WMTPSessionHandle psession_handle,
in WMTPProcInstID pproc_inst_id,
out WMTPProcInstID pnew_proc_inst_id );
WMTErrRetType WMTerminateProcessInstance (
in WMTPSessionHandle psession_handle,
in WMTPProcInstID pproc_inst_id);
WMTErrRetType WMOpenProcessInstanceStatesList (
in WMTPSessionHandle psession_handle,
in WMTPProcInstID pproc_inst_id,
in WMTPFilter pproc_inst_state_filter,
in WMTBoolean count_flag,
out WMTPQueryHandle pquery_handle,
out WMTPInt32 pcount);
WMTErrRetType WMFetchProcessInstanceState (
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle,
out WMTPProcInstState pproc_inst_state);
WMTErrRetType WMCloseProcessInstanceStatesList (
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle);
WMTErrRetType WMChangeProcessInstanceState (
in WMTPSessionHandle psession_handle,
in WMTPProcInstID pproc_inst_id,
in WMTPProcInstState pproc_inst_state);
WMTErrRetType WMOpenProcessInstanceAttributesList (
in WMTPSessionHandle psession_handle,
in WMTPProcInstID pproc_inst_id,
in WMTPFilter pproc_inst_attr_filter,
in WMTBoolean count_flag,
out WMTPQueryHandle pquery_handle,
out WMTPInt32 pcount);
WMTErrRetType WMFetchProcessInstanceAttribute (
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle,
out WMTPAttrName pattribute_name,
out WMTPInt32 pattribute_type,
out WMTPInt32 pattribute_length,
out WMTPText pattribute_value,
in WMTInt32 buffer_size);
WMTErrRetType WMCloseProcessInstanceAttributesList (
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle);
WMTErrRetType WMGetProcessInstanceAttributeValue (
in WMTPSessionHandle psession_handle,
in WMTPProcInstID pproc_inst_id,
in WMTPAttrName pattribute_name,
out WMTPInt32 pattribute_type,
out WMTPInt32 pattribute_length,
out WMTPText pattribute_value,
in WMTInt32 buffer_size);
WMTErrRetType WMAssignProcessInstanceAttribute (
in WMTPSessionHandle psession_handle,
in WMTPProcInstID pproc_inst_id,
in WMTPAttrName pattribute_name,
in WMTInt32 attribute_type,
in WMTInt32 attribute_length,
in WMTPText pattribute_value);
WMTErrRetType WMOpenActivityInstanceStatesList (
in WMTPSessionHandle psession_handle,
in WMTPProcInstID pproc_inst_id,
in WMTPActivityInstID pactivity_inst_id,
in WMTPFilter pact_inst_state_filter,
in WMTBoolean count_flag,
out WMTPQueryHandle pquery_handle,
out WMTPInt32 pcount);
WMTErrRetType WMFetchActivityInstanceState (
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle,
out WMTPActivityInstState pactivity_inst_state);
WMTErrRetType WMCloseActivityInstanceStatesList (
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle);
WMTErrRetType WMChangeActivityInstanceState (
in WMTPSessionHandle psession_handle,
in WMTPProcInstID pproc_inst_id,
in WMTPActivityInstID pactivity_inst_id,
in WMTPActivityInstState pactivity_inst_state);
WMTErrRetType WMOpenActivityInstanceAttributesList (
in WMTPSessionHandle psession_handle,
in WMTPProcInstID pproc_inst_id,
in WMTPActivityInstID pactivity_inst_id,
in WMTPFilter pact_inst_attr_filter,
in WMTBoolean count_flag,
out WMTPQueryHandle pquery_handle,
out WMTPInt32 pcount);
WMTErrRetType WMFetchActivityInstanceAttribute (
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle,
out WMTPAttrName pattribute_name,
out WMTPInt32 pattribute_type,
out WMTPInt32 pattribute_length,
out WMTPText pattribute_value,
in WMTInt32 buffer_size);
WMTErrRetType WMCloseActivityInstanceAttributesList (
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle);
WMTErrRetType WMGetActivityInstanceAttributeValue (
in WMTPSessionHandle psession_handle,
in WMTPProcInstID pproc_inst_id,
in WMTPActivityInstID pactivity_inst_id,
in WMTPAttrName pattribute_name,
out WMTPInt32 pattribute_type,
out WMTPInt32 pattribute_length,
out WMTPText pattribute_value,
in WMTInt32 buffer_size);
WMTErrRetType WMAssignActivityInstanceAttribute (
in WMTPSessionHandle psession_handle,
in WMTPProcDefID pproc_def_id,
in WMTPActivityInstID pactivity_inst_id,
in WMTPAttrName pattribute_name,
in WMTInt32 attribute_type,
in WMTInt32 attribute_length,
in WMTPText pattribute_value);
WMTErrRetType WMOpenProcessInstancesList (
in WMTPSessionHandle psession_handle,
in WMTPFilter pproc_inst_filter,
in WMTBoolean count_flag,
out WMTPQueryHandle pquery_handle,
out WMTPInt32 pcount);
WMTErrRetType WMFetchProcessInstance (
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle,
out WMTPProcInst pproc_inst_buf_ptr);
WMTErrRetType WMCloseProcessInstancesList (
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle);
WMTErrRetType WMGetProcessInstance (
in WMTPSessionHandle psession_handle,
in WMTPProcInstID pproc_inst_id,
out WMTPProcInst pproc_inst);
WMTErrRetType WMOpenActivityInstancesList (
in WMTPSessionHandle psession_handle,
in WMTPFilter pactivity_inst_filter,
in WMTBoolean count_flag,
out WMTPQueryHandle pquery_handle,
out WMTPInt32 pcount);
WMTErrRetType WMFetchActivityInstance (
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle,
out WMTPActivityInst pactivity_inst);
WMTErrRetType WMCloseActivityInstancesList (
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle);
WMTErrRetType WMGetActivityInstance (
in WMTPSessionHandle psession_handle,
in WMTPProcInstID pproc_inst_id,
in WMTPActivityInstID pactivity_inst_id,
out WMTPActivityInst pactivity_inst );
WMTErrRetType WMOpenWorkList (
in WMTPSessionHandle psession_handle,
in WMTPFilter pworklist_filter,
in WMTBoolean count_flag,
out WMTPQueryHandle pquery_handle,
out WMTPInt32 pcount);
WMTErrRetType WMFetchWorkItem (
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle,
out WMTPWorkItem pwork_item);
WMTErrRetType WMCloseWorkList (
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle);
WMTErrRetType WMGetWorkItem (
in WMTPSessionHandle psession_handle,
in WMTPProcInstID pproc_inst_id,
in WMTPWorkItemID pwork_item_id,
out WMTPWorkItem pwork_item );
WMTErrRetType WMCompleteWorkItem (
in WMTPSessionHandle psession_handle,
in WMTPProcInstID pproc_inst_id,
in WMTPWorkItemID pwork_item_id);
WMTErrRetType WMReassignWorkItem (
in WMTPSessionHandle psession_handle,
in WMTPWflParticipant psource_user,
in WMTPWflParticipant ptarget_user,
in WMTPProcInstID pproc_inst_id,
in WMTPWorkItemID pwork_item_id);
WMTErrRetType WMOpenWorkItemAttributesList (
in WMTPSessionHandle psession_handle,
in WMTPProcInstID pproc_inst_id,
in WMTPWorkItemID pwork_item_id,
in WMTPFilter pwork_item_attr_filter,
in WMTBoolean count_flag,
out WMTPQueryHandle pquery_handle,
out WMTPInt32 pcount);
WMTErrRetType WMFetchWorkItemAttribute (
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle,
out WMTPAttrName pattribute_name,
out WMTPInt32 pattribute_type,
out WMTPInt32 pattribute_length,
out WMTPText pattribute_value,
in WMTInt32 buffer_size);
WMTErrRetType WMCloseWorkItemAttributesList (
in WMTPSessionHandle psession_handle,
in WMTPQueryHandle pquery_handle);
WMTErrRetType WMGetWorkItemAttributeValue (
in WMTPSessionHandle psession_handle,
in WMTPProcInstID pproc_inst_id,
in WMTPWorkItemID pwork_item_id,
in WMTPAttrName pattribute_name,
out WMTPInt32 pattribute_type,
out WMTPInt32 pattribute_length,
out WMTPText pattribute_value,
in WMTInt32 buffer_size);
WMTErrRetType WMAssignWorkItemAttribute (
in WMTPSessionHandle psession_handle,
in WMTPProcInstID pproc_inst_id,
in WMTPWorkItemID pwork_item_id,
in WMTPAttrName pattribute_name,
in WMTInt32 attribute_type,
in WMTInt32 attribute_length,
in WMTPText pattribute_value);
WMTErrRetType WMChangeProcessInstancesState (
in WMTPSessionHandle psession_handle,
in WMTPProcDefID pproc_def_id,
in WMTPFilter pproc_inst_filter,
in WMTProcInstState pproc_inst_state);
WMTErrRetType WMChangeActivityInstancesState (
in WMTPSessionHandle psession_handle,
in WMTPProcDefID pproc_def_id,
in WMTPActivityID pactivity_def_id,
in WMTPFilter pact_inst_filter,
in WMTPActivityInstState pactivity_inst_state);
WMTErrRetType WMTerminateProcessInstances (
in WMTPSessionHandle psession_handle,
in WMTPProcDefID pproc_def_id,
in WMTPFilter pproc_inst_filter);
WMTErrRetType WMAssignProcessInstancesAttribute (
in WMTPSessionHandle psession_handle,
in WMTPProcDefID pproc_def_id,
in WMTPFilter pproc_inst_filter,
in WMTAttrName attribute_name,
in WMTInt32 attribute_type,
in WMTInt32 attribute_length,
in WMTPText pattribute_value);
WMTErrRetType WMAssignActivityInstancesAttribute (
in WMTPSessionHandle psession_handle,
in WMTPProcDefID pproc_def_id,
in WMTPActivityID pactivity_def_id,
in WMTPFilter pact_inst_filter,
in WMTPAttrName pattribute_name,
in WMTInt32 attribute_type,
in WMTInt32 attribute_length,
in WMTPText pattribute_value);
WMTErrRetType WMAbortProcessInstances (
in WMTPSessionHandle psession_handle,
in WMTPProcDefID pproc_def_id,
in WMTPFilter pproc_inst_filter);
WMTErrRetType WMAbortProcessInstance (
in WMTPSessionHandle psession_handle,
in WMTPProcInstID pproc_inst_id);
/**************************************************************************
End of wmAPI.h
*/
#endif
Include
File - wmerror.h
File: wmerror.h
1 2 3 4 5 6 7 8
1234567890123456789012345678901234567890123456789012345678901234567890123456790
/*
WMERROR.H
This is the file supplied by the Workflow Management Coalition.
It contains defines for the error codes support by the WAPI.
*/
#ifndef WMERR_H
#define WMERR_H
#define WM_MAIN_ERR_MASK 0xFFFF0000
#define WM_SUB_ERR_MASK 0x0000FFFF
#define WM_SUCCESS 0
#define WM_CONNECT_FAILED 0x00100000
#define WM_INVALID_PROCESS_DEFINITION 0x00200000
#define WM_INVALID_ACTIVITY_NAME 0x00300000
#define WM_INVALID_PROCESS_INSTANCE 0x00400000
#define WM_INVALID_ACTIVITY_INSTANCE 0x00500000
#define WM_INVALID_WORKITEM 0x00600000
#define WM_INVALID_ATTRIBUTE 0x00700000
#define WM_ATTRIBUTE_ASSIGNMENT_FAILED 0x00800000
#define WM_INVALID_STATE 0x00900000
#define WM_TRANSITION_NOT_ALLOWED 0x00A00000
#define WM_INVALID_SESSION_HANDLE 0x00B00000
#define WM_INVALID_QUERY_HANDLE 0x00C00000
#define WM_INVALID_SOURCE_USER 0x00D00000
#define WM_INVALID_TARGET_USER 0x00E00000
#define WM_INVALID_FILTER 0x00F00000
#define WM_LOCKED 0x00F10000
#define WM_NOT_LOCKED 0x00F20000
#define WM_NO_MORE_DATA 0x00F30000
#define WM_INSUFFICIENT_BUFFER_SIZE 0x00F40000
/**************************************************************************
End of wmerror.h
*/
#endif