AudioFile.GetUserData Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| GetUserData(AudioFileChunkType, Int32, Int32, IntPtr) |
Get part of the data of a chunk in a file. |
| GetUserData(Int32, Int32, Int32, IntPtr) |
Get part of the data of a chunk in a file. |
| GetUserData(AudioFileChunkType, Int32, Int64, Byte[], Int32) |
Get part of the data of a chunk in a file. |
| GetUserData(AudioFileChunkType, Int32, Int64, Int32, IntPtr) |
Get part of the data of a chunk in a file. |
| GetUserData(UInt32, Int32, Int64, Byte[], Int32) |
Get part of the data of a chunk in a file. |
| GetUserData(UInt32, Int32, Int64, Int32, IntPtr) |
Get part of the data of a chunk in a file. |
GetUserData(AudioFileChunkType, Int32, Int32, IntPtr)
Get part of the data of a chunk in a file.
public AudioToolbox.AudioFileError GetUserData(AudioToolbox.AudioFileChunkType chunkType, int index, ref int size, IntPtr userData);member this.GetUserData : AudioToolbox.AudioFileChunkType * int * int * nativeint -> AudioToolbox.AudioFileErrorParameters
- chunkType
- AudioFileChunkType
The fourcc of the chunk.
- index
- Int32
The index of the chunk if there are more than one chunks.
- size
- Int32
On input the size of the memory userData points to. On output the number of bytes written.
- userData
-
IntPtr
nativeint
A pointer to memory where the data will be copied.
Returns
Returns Success on success, otherwise an AudioFileError error code.
Applies to
GetUserData(Int32, Int32, Int32, IntPtr)
Get part of the data of a chunk in a file.
public int GetUserData(int userDataID, int index, ref int size, IntPtr userData);member this.GetUserData : int * int * int * nativeint -> intParameters
- userDataID
- Int32
The fourcc of the chunk.
- index
- Int32
The index of the chunk if there are more than one chunks.
- size
- Int32
On input the size of the memory userData points to. On output the number of bytes written.
- userData
-
IntPtr
nativeint
A pointer to memory where the data will be copied.
Returns
Returns Success on success, otherwise an AudioFileError error code.
Applies to
GetUserData(AudioFileChunkType, Int32, Int64, Byte[], Int32)
Get part of the data of a chunk in a file.
public AudioToolbox.AudioFileError GetUserData(AudioToolbox.AudioFileChunkType chunkType, int index, long offset, byte[] data, out int size);member this.GetUserData : AudioToolbox.AudioFileChunkType * int * int64 * byte[] * int -> AudioToolbox.AudioFileErrorParameters
- chunkType
- AudioFileChunkType
The fourcc of the chunk.
- index
- Int32
The index of the chunk if there are more than one chunks.
- offset
- Int64
The offset from the first byte of the chunk of the data to get.
- data
- Byte[]
An array of bytes where the data will be copied.
- size
- Int32
The number of bytes written into the byte array.
Returns
Returns Success on success, otherwise an AudioFileError error code.
Applies to
GetUserData(AudioFileChunkType, Int32, Int64, Int32, IntPtr)
Get part of the data of a chunk in a file.
public AudioToolbox.AudioFileError GetUserData(AudioToolbox.AudioFileChunkType chunkType, int index, long offset, ref int size, IntPtr userData);member this.GetUserData : AudioToolbox.AudioFileChunkType * int * int64 * int * nativeint -> AudioToolbox.AudioFileErrorParameters
- chunkType
- AudioFileChunkType
The fourcc of the chunk.
- index
- Int32
The index of the chunk if there are more than one chunks.
- offset
- Int64
The offset from the first byte of the chunk of the data to get.
- size
- Int32
On input the size of the memory userData points to. On output the number of bytes written.
- userData
-
IntPtr
nativeint
A pointer to memory where the data will be copied.
Returns
Returns Success on success, otherwise an AudioFileError error code.
Applies to
GetUserData(UInt32, Int32, Int64, Byte[], Int32)
Get part of the data of a chunk in a file.
public AudioToolbox.AudioFileError GetUserData(uint userDataId, int index, long offset, byte[] data, out int size);member this.GetUserData : uint32 * int * int64 * byte[] * int -> AudioToolbox.AudioFileErrorParameters
- userDataId
- UInt32
The fourcc of the chunk.
- index
- Int32
The index of the chunk if there are more than one chunks.
- offset
- Int64
The offset from the first byte of the chunk of the data to get.
- data
- Byte[]
An array of bytes where the data will be copied.
- size
- Int32
The number of bytes written into the byte array.
Returns
Returns Success on success, otherwise an AudioFileError error code.
Applies to
GetUserData(UInt32, Int32, Int64, Int32, IntPtr)
Get part of the data of a chunk in a file.
public AudioToolbox.AudioFileError GetUserData(uint userDataId, int index, long offset, ref int size, IntPtr userData);member this.GetUserData : uint32 * int * int64 * int * nativeint -> AudioToolbox.AudioFileErrorParameters
- userDataId
- UInt32
The fourcc of the chunk.
- index
- Int32
The index of the chunk if there are more than one chunks.
- offset
- Int64
The offset from the first byte of the chunk of the data to get.
- size
- Int32
On input the size of the memory userData points to. On output the number of bytes written.
- userData
-
IntPtr
nativeint
A pointer to memory where the data will be copied.
Returns
Returns Success on success, otherwise an AudioFileError error code.