PrlHandle_GetType Function

Returns the type of the specified handle.

Syntax

PRL_RESULT PrlHandle_GetType(
    PRL_HANDLE handle, 
    PRL_HANDLE_TYPE_PTR type
);

File

PrlApi.h

Parameters

handle

Handle to get the type for.

type

[out] A pointer to a variable that receives the result. The type is returned as an enumerator of the PRL_HANDLE_TYPE enumeration.

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

Handle is an abstraction that is used to hide an object implementation. While there are many methods used to access functionality of different objects, this method is used to identify object type as one of the PRL_HANDLE_TYPE types.

Links

PrlApi.h , Handle Functions