NAME

CSSM_DL_PassThrough

SYNOPSIS

void * CSSMAPI DL_PassThrough
    (CSSM_DL_DB_HANDLE DLDBHandle,
    uint32 PassThroughId,
    const void *InputParams)

DESCRIPTION

This function allows applications to call data storage library module-specific operations that have been exported. Such operations may include queries or services that are specific to the domain represented by a DL module.

PARAMETERS

DLDBHandle (input)

The handle pair that describes the add-in data storage library module to be used to perform this function and the open data store upon which the function is to be performed.

PassThroughId (input)

An identifier assigned by a DL module to indicate the exported function to be performed.

InputParams (input)

A pointer to a module implementation-specific structure containing parameters to be interpreted in a function-specific manner by the requested DL module.

RETURN VALUE

A pointer to a module implementation-specific structure containing the output from the pass-through function. The output data must be interpreted by the calling application based on externally-available information. If the pointer is NULL, an error has occurred. Use CSSM_GetError to obtain the error code.

ERRORS

CSSM_DL_INVALID_DL_HANDLE

Invalid DL handle.

CSSM_DL_INVALID_DB_HANDLE

Invalid DB handle.

CSSM_DL_INVALID_PASSTHROUGH_ID

Invalid passthrough ID.

CSSM_DL_INVALID_PTR

Invalid pointer.

CSSM_DL_PASS_THROUGH_FAIL

DB exception doing passthrough function.

CSSM_DL_MEMORY_ERROR

Error in allocating memory.