StarBurn_CdvdBurnerGrabber_ExecuteGeneric Function

C++

__stdcall STARBURN_IMPEX_API EXCEPTION_NUMBER StarBurn_CdvdBurnerGrabber_ExecuteGeneric(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, IN PUCHAR p__PUCHAR__CDB, IN ULONG p__ULONG__CDBSizeInUCHARs, IN OUT PUCHAR p__PUCHAR__DataBuffer, IN ULONG p__ULONG__DataBufferSizeInUCHARs, IN BOOLEAN p__BOOLEAN__IsDirectionToScsiTarget);

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.
IN PUCHAR p__PUCHAR__CDB	Pointer to CDB we want to execute.
IN ULONG p__ULONG__CDBSizeInUCHARs	CDB size in UCHARs.
IN OUT PUCHAR p__PUCHAR__DataBuffer	Pointer to I/O data buffer.
IN ULONG p__ULONG__DataBufferSizeInUCHARs	I/O data buffer size in UCHARs.
IN BOOLEAN p__BOOLEAN__IsDirectionToScsiTarget	Is data moved from memory-to-target (TRUE) or from target-to-memory (FALSE).

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 executes custom CDB (Command Descriptor Block) on CD/DVD/Blu-Ray/HD-DVD burner device object. This could be used to deal with the propriatry hardware or execute some special code StarBurn does not support out-of-box.

Remarks

Please see ExecuteGeneric sample on how to send custom SCSI commands to CD/DVD/Blu-Ray/HD-DVD burner device.

Example

This example allocates CdvdBurnerGrabber object, sends custom command 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;
UCHAR l__UCHAR__CDB[ 12 ];
UCHAR l__UCHAR__Data[ 0x2000 ];

// 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...
}

// Format CDB and data buffer here...

// Try to send custom CDB to CD/DVD/Blu-Ray/HD-DVD burner device
l__EXCEPTION_NUMBER =
StarBurn_CdvdBurnerGrabber_ExecuteGeneric(
    l__PVOID__CdvdBurnerGrabber,
    ( PCHAR )( &l__CHAR__ExceptionText ),
    sizeof( l__CHAR__ExceptionText ),
    &l__ULONG__SystemError,
    &l__CDB_FAILURE_INFORMATION,
    &l__UCHAR__CDB,
    sizeof( l__UCHAR__CDB ),
    &l__UCHAR__Data,
    sizeof( l__UCHAR__Data ),
    TRUE
    );
    
// Check for correct reply
if (  l__EXCEPTION_NUMBER != EN_SUCCESS )
{
// Handle error here...
}

// Do something with CdvdBurnerGrabber device object 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