IXACTCue::GetProperties

IXACTCue::GetProperties

Retrieves the properties of the cue.

[Content-driven]

  HRESULT 
  GetProperties(
  LPXACT_CUE_INSTANCE_PROPERTIES *ppProperties
);

Parameters

• ppProperties
  [out] Pointer to an XACT_CUE_INSTANCE_PROPERTIES structure that contains the cue properties.

Return Values

Returns S_OK if successful, an error code otherwise.

Remarks

GetProperties will allocate memory for the XACT_CUE_INSTANCE_PROPERTIES structure.

Xbox 360:  GetProperties performs memory allocation using XMemAlloc.

The caller should free the memory using XMemFree. As an example:

LPXACT_CUE_INSTANCE_PROPERTIES pCueProperties = NULL;
if ( FAILED( pCue->GetProperties( &pCueProperties ) ) )
{
    // Error
}
XMemFree( pCueProperties, pCueProperties->allocAttributes );

Windows:  The caller should free the memory using CoTaskMemAlloc. The caller should free the memory using CoTaskMemFree. As an example:

LPXACT_CUE_INSTANCE_PROPERTIES pCueProperties = NULL;
if ( FAILED( pCue->GetProperties( &pCueProperties ) ) )
{
    // Error
}
CoTaskMemFree( (void*)pCueProperties );

Requirements

Header: Declared in Xact.h.

Library: Use Xact.lib.

See Also

IXACTCue