version 2003
PA_GetLongParameter (params; index) long
Parameter | Type | Description | |
params | PA_PluginParameters | Parameters received in PluginMain | |
index | short | Index of the parameter in params | |
Function result | long | Value of the index parameter |
Description
The routine PA_GetLongParameter returns the value, of type long, of the index parameter in params.
See Create a new plugin for a description of parameter accessors.
NOTE:
The first parameter starts at index 1.
Example
Getting first and second parameters, short and then long.
void PluginMain( long selector, PA_PluginParameter params ) { switch ( selector ) { . . .kInitPlugin, kDeinitPlugin... case kMyRoutine : DoMyRoutine(params ); break; } } void DoMyRoutine (PA_PluginParameters params) { short theShort; long theLong; // Get the first parameter value theShort = PA_GetShortParameter(params, 1); // Get the second parameter value theLong = PA_GetLongParameter(params, 2); // . . . do something with it . . . }
See Also
Error Handling
PA_GetLastError keeps the last error that occurred before calling the routine.