McGetParamNmStr

Returns the current value of a MultiCam parameter as a string variable. The parameter is referred to by-name, and is preferably of the string or enumerated type.

[C]

MCSTATUS McGetParamNmStr(
  MCHANDLE Instance,
  PCHAR ParamName,
  PCHAR ValueStr,
  UINT32 MaxLength
);

Parameters

Instance

Handle of the instance of the parameter to read.

ParamName

Pointer to a string containing the name of the parameter to read.

ValueStr

Pointer to the string variable that receives the parameter value.

MaxLength

Maximum number of characters in the read string.

Example

The following code gets the channel-class select-level string parameter BoardIdentifier. The last argument is the size of the buffer where the returned string is to be hosted. It should be large enough to accommodate any possible returned string parameter.

//Declaring a string variable

CHAR MyBoard[32];

//Getting the parameter using the by-name method

Status = McGetParamNmStr(ObjectHandle, "BoardIdentifier", &MyBoard, 32);

Remarks

If the MultiCam parameter is not of the string type, a type conversion is performed.