NAME

CSSM_DL_DbExport

SYNOPSIS

CSSM_RETURN CSSMAPI CSSM_DL_DbExport
    (CSSM_DL_HANDLE DLHandle,
    const char *DbDestinationName,
    const CSSM_NET_ADDRESS_PTR DbDestinationLocation,
    const char *DbSourceName,
    const CSSM_NET_ADDRESS_PTR DbSourceLocation,
    const CSSM_BOOL InfoOnly,
    const CSSM_USER_AUTHENTICATION_PTR UserAuthentication)
    const void *DestinationOpenParameters,
    const void *SourceOpenParameters)

DESCRIPTION

This function exports a copy of the data store records from the source data store to a data container that can be used as the input data source for the CSSM_DL_DbImport function. The DL module may require additional user authentication to determine authorization to snapshot a copy of an existing data store.

PARAMETERS

DLHandle (input)

The handle that describes the add-in data storage library module to be used to perform this function.

DbDestinationName (input)

The name of the destination data container to contain a copy of the source data store's records.

DbDestinationLocation (input/optional)

A pointer to a network address directly or indirectly identifying the location of the storage service process. If the input is NULL, the module can determine a storage service process and its location based on the DbDestinationName or can assume a default storage service process location. If the DbDestinationName does not distinguish the storage service process and a default cannot be assumed, the service cannot be performed and the operation fails.

DbSourceName (input)

The name of the data store from which the records are to be exported.

DbSourceLocation (input/optional)

A pointer to a network address directly or indirectly identifying the location of the storage service process. If the input is NULL, the module can determine a storage service process and its location based on the DbSourceName or can assume a default storage service process location. If the DbSourceName does not distinguish the storage service process and a default cannot be assumed, the service cannot be performed and the operation fails.

InfoOnly (input)

A Boolean value indicating what to export. If TRUE, export only the DBInfo, which describes the a data store. If FALSE, export both the DBInfo and all of the records in the specified data store.

UserAuthentication (input/optional)

The caller's credential as required for authorization to snapshot/copy a data store. If the DL module requires no additional credentials to perform this operation, then user authentication can be NULL.

DestinationOpenParameters (input/optional)

A pointer to a module-specific set of parameters required to open the destination data store.

SourceOpenParameters (input/optional)

A pointer to a module-specific set of parameters required to open the source data store.

RETURN VALUE

A CSSM_OK return value signifies that the function completed successfully. When CSSM_FAIL is returned, an error has occurred. Use CSSM_GetError to obtain the error code.

ERRORS

CSSM_DL_INVALID_DL_HANDLE

Invalid DL handle.

CSSM_DL_INVALID_PTR

NULL source or destination names.

CSSM_DL_DB_EXPORT_FAIL

DB exception doing export function.

CSSM_DL_MEMORY_ERROR

Error in allocating memory.

SEE ALSO

CSSM_DL_DbImport