PrlApi_CreateOpTypeList Function

Creates a new handle of type PHT_OPAQUE_TYPE_LIST .

Syntax

PRL_RESULT PrlApi_CreateOpTypeList(
    PRL_HANDLE_PTR phOpTypeList, 
    PRL_SIZE nTypeSize
);

File

PrlApiCore.h

Parameters

phOpTypeList

[out] A pointer to a variable that receives the handle.

nTypeSize

size of opaque type for which list should be instantiated

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - null pointer was passed or size of not supported opaque type was passed. In order to determine list of supported opaque types please refer with PrlTypes.h.

PRL_ERR_OUT_OF_MEMORY - not enough memory to create the list object.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

Simple sample of method usage follow:

PrlApi_CreateOpTypeList(&hOpTypeList, sizeof( PRL_UINT32 ));

Links

System Functions