StarBurn_CdvdBurnerGrabber_GetMechanicalOptions Function

C++

__stdcall STARBURN_IMPEX_API EXCEPTION_NUMBER StarBurn_CdvdBurnerGrabber_GetMechanicalOptions(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__IsLockUnLockSupported, OUT PBOOLEAN p__PBOOLEAN__IsLocked, OUT PBOOLEAN p__PBOOLEAN__IsLoadEjectSupported, OUT PUCHAR p__PUCHAR__LoadingMechanismType);

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.
OUT PBOOLEAN p__PBOOLEAN__IsLockUnLockSupported	Pointer to the variable to receive is device capable of programmatical lock/unlock.
OUT PBOOLEAN p__PBOOLEAN__IsLocked	Pointer to the variable to receive is media inside device locked right now.
OUT PBOOLEAN p__PBOOLEAN__IsLoadEjectSupported	Pointer to the variable to receive is device capable of programmatical load/eject.
OUT PUCHAR p__PUCHAR__LoadingMechanismType	Pointer to the variable to receive device loading mechanism type.

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 gets mechanical options (is device capable of programmatical load/eject and lock/unlock etc) from CD/DVD/Blu-Ray/HD-DVD burner device object.

Remarks

Please see the TrackAtOnceFromFile sample that will demonstrate how ISO9660 or Joliet file system image can be burn to the CD/DVD/Blu-Ray/HD-DVD media and how StarBurn_CdvdBurnerGrabber_GetMechanicalOptions() can be used to determine device media control capabilities.

Example

This example allocates CdvdBurnerGrabber object, gets mechanical options 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__IsLockUnLockSupported = FALSE;
BOOLEAN l__BOOLEAN__IsLocked = FALSE;
BOOLEAN l__BOOLEAN__IsLoadEjectSupported = FALSE;
UCHAR l__UCHAR__LoadingMechanismType = 0x00;

// 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 get media and tray statuses
l__EXCEPTION_NUMBER =
StarBurn_CdvdBurnerGrabber_GetMechanicalOptions(
    l__PVOID__CdvdBurnerGrabber,
    ( PCHAR )( &l__CHAR__ExceptionText ),
    sizeof( l__CHAR__ExceptionText ),
    &l__ULONG__SystemError,
    &l__CDB_FAILURE_INFORMATION,
    &l__BOOLEAN__IsLockUnLockSupported,
    &l__BOOLEAN__IsLocked,
    &l__BOOLEAN__IsLoadEjectSupported,
    &l__UCHAR__LoadingMechanismType
    );
    
// 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