CustomProcess_GetMetadata

CustomProcess_GetMetadata Function

Applies To: Implementing a custom process

Returns process metadata as an array of NVM's.

This function is used to get the metadata from the process.

[C++]

CustomProcess_API void* __stdcall CustomProcess_GetMetadata(void* clientHandle,

unsigned long* numProps);

Arguments

[in] clientHandle

Unique ID used to identify the caller.

[in,out] numProps

Number of metadata properties returned.

Return Value

Array of NVM's with the metadata properties.

Reporting errors and warnings: Any errors can be obtained by calling the GetLastError function which will give out the error message for the last error in the DLL.

Example

The following example represents a partial C++ implementation of this function:

[C++]

CustomProcess_API void* __stdcall CustomProcess_GetMetadata(

void* clientHandle, unsigned long* numProps)

{

ClientHandle* myClientHandle = (ClientHandle*)clientHandle;

myClientHandle->myNumMetadata = 1;

*numProps = myClientHandle->myNumMetadata;

myClientHandle->myProcessMetadata = malloc(sizeof(NVM) * myClientHandle->myNumMetadata);

myClientHandle->myProcessMetadata[0].Name = malloc(sizeof(char) * 25);

myClientHandle->myProcessMetadata[0].Value = malloc(sizeof(char) * 25);

strcpy_s(myClientHandle->myProcessMetadata[0].Name, 25, "Process Applied");

strcpy_s(myClientHandle->myProcessMetadata[0].Value, 25, "Sultans Process");

return (void*)myClientHandle->myProcessMetadata;

}

For a detailed example on how to implement this function, see Sample custom process.