StarBurn_CdvdBurnerGrabber_ProbeSupportedReadModes Function

C++

__stdcall STARBURN_IMPEX_API EXCEPTION_NUMBER StarBurn_CdvdBurnerGrabber_ProbeSupportedReadModes(IN PVOID p__PVOID__CdvdBurnerGrabber, OUT PCHAR p__PCHAR__ExceptionText, IN ULONG p__ULONG__ExceptionTextSizeInUCHARs, OUT PULONG p__PULONG__SystemError, OUT PCDB_FAILURE_INFORMATION p__PCDB_FAILURE_INFORMATION, OUT PBOOLEAN p__PBOOLEAN__IsCooked, OUT PBOOLEAN p__PBOOLEAN__IsRaw, OUT PBOOLEAN p__PBOOLEAN__IsRawQ, OUT PBOOLEAN p__PBOOLEAN__IsRawRawPW, OUT PBOOLEAN p__PBOOLEAN__IsPQ, OUT PBOOLEAN p__PBOOLEAN__IsRawPW);

File

StarBurn.h

Parameters

Parameters	Description
IN PVOID p__PVOID__CdvdBurnerGrabber	Pointer to the CdvdBurnerGrabber object that toolkit allocated before.
OUT PCHAR p__PCHAR__ExceptionText	Pointer to array of CHARs that will be used to store formatted exception description message.
IN ULONG p__ULONG__ExceptionTextSizeInUCHARs	Size of the array of CHARs used to be formatted exception message storage.
OUT PULONG p__PULONG__SystemError	Pointer to ULONG that will contain the system error (if some will occur).
OUT PCDB_FAILURE_INFORMATION p__PCDB_FAILURE_INFORMATION	Pointer to CDB_FAILURE_INFORMATION that will be filled with apropriate values.
p__BOOLEAN__IsCooked	Is cooked mode supported.
p__BOOLEAN__IsRaw	Is raw mode supported.
p__BOOLEAN__IsRawPQ	Is raw + PQ subchannel mode supported.
p__BOOLEAN__IsRawRawPW	Is raw + raw P-W subchannel mode supported.
p__BOOLEAN__IsPQ	Is PQ subchannel mode supported.
p__BOOLEAN__IsRawPW	Is raw P-W subchannel mode supported.

Returns

Execution status. EN_SUCCESS if the operation completed successfuly. If the exception number will be EN_SYSTEM_CALL_FAILED, variable that SystemError points to will be filled with system error. If something other then EN_SUCCESS will be returned buffer that ExceptionText will point to will be filled with formatted exception message. If the exception number will be EN_SCSI_CDB_FAILED, CDB_FAILURE_INFORMATION will be filled with apropriate values (CDB that faled, CDB size, SCSI sense data, SCSI sense data size, SCSI transport, device and host adapter status codes).

Description

This function probes supported read modes on the currently inserted disc on CD/DVD/Blu-Ray/HD-DVD burner device.

Remarks

Please see the GrabDisc sample that will demonstrate how whole disc image can be grabbed from the CD/DVD/Blu-Ray/HD-DVD media and how StarBurn_CdvdBurnerGrabber_ProbeSupportedReadModes can be used to determine supported read modes.

[ WARNING! It's required to have media inserted for this function to work properly! ]

Example

This example allocates CdvdBurnerGrabber object, probes supported read modes and destroys the device object after it's not needed any more.

// Somewhere in the data region
PVOID l__PVOID__CdvdBurnerGrabber;
EXCEPTION_NUMBER l__EXCEPTION_NUMBER;
ULONG l__ULONG__SystemError;
CHAR l__CHAR__ExceptionText[ 1024 ];
CDB_FAILURE_INFORMATION l__CDB_FAILURE_INFORMATION;
BOOLEAN l__BOOLEAN__IsCooked = FALSE;
BOOLEAN l__BOOLEAN__IsRaw = FALSE;
BOOLEAN l__BOOLEAN__IsRawPQ = FALSE;
BOOLEAN l__BOOLEAN__IsRawRawPW = FALSE;
BOOLEAN l__BOOLEAN__IsPQ = FALSE;
BOOLEAN l__BOOLEAN__IsRawPW = FALSE;

// Prepare exception text buffer
RtlZeroMemory(
    &l__CHAR__ExceptionText,
    sizeof( l__CHAR__ExceptionText )
    );

// Prepare CDB failure information
RtlZeroMemory(
    &l__CDB_FAILURE_INFORMATION,
    sizeof( l__CDB_FAILURE_INFORMATION )
    );

// Try to create CdvdBurnerGrabber on 0:0:4:0 with 32MB of cache
l__EXCEPTION_NUMBER =
StarBurn_CdvdBurnerGrabber_Create(
    &l__PVOID__CdvdBurnerGrabber,
    ( PCHAR )( &l__CHAR__ExceptionText ),
    sizeof( l__CHAR__ExceptionText ),
    &l__ULONG__SystemError,
    &l__CDB_FAILURE_INFORMATION,
    ( PCALLBACK )( StarBurn_Callback ),
    0,
    0,
    4,
    0,
    32
    );

// Check for correct reply
if (  l__EXCEPTION_NUMBER != EN_SUCCESS )
{
// Handle error here...
}

// Try to probe supported read modes
l__EXCEPTION_NUMBER =
StarBurn_CdvdBurnerGrabber_ProbeSupportedReadModes(
    l__PVOID__CdvdBurnerGrabber,
    ( PCHAR )( &l__CHAR__ExceptionText ),
    sizeof( l__CHAR__ExceptionText ),
    &l__ULONG__SystemError,
    &l__CDB_FAILURE_INFORMATION,
    &l__BOOLEAN__IsCooked,
    &l__BOOLEAN__IsRaw,
    &l__BOOLEAN__IsRawPQ,
    &l__BOOLEAN__IsRawRawPW,
    &l__BOOLEAN__IsPQ,
    &l__BOOLEAN__IsRawPW
    );

// Check for correct reply
if (  l__EXCEPTION_NUMBER != EN_SUCCESS )
{
// Handle error here...
}

// Do something with CdvdBurnerGrabber device object and supported read modes information here...       

// Destroy the CdvdBurnerGrabber
StarBurn_Destroy( &l__PVOID__CdvdBurnerGrabber );

// Just check for pointer (paranoid?)
if ( l__PVOID__CdvdBurnerGrabber != NULL )
{
// Handle error here...
}

Group

Functions

Links

StarBurn.h, Functions, Example, See Also

Contents | Index | Home