IMCBoard::GetParamStr
HRESULT GetParamStr(
UINT32 unParamId,
PWSTR pszValue,
long ccValue
);
unParamId |
[in] Identifier of a MultiCam board parameter. |
pszValue |
[out] Pointer to caller-allocated unicode string that contains the value of the board parameter. |
ccValue |
[in] Size of the character string. |
This function retrieves the value of a MultiCam board parameter.
Whatever the parameter type is, the value is converted and returned as a string.
Return Values
Returns an HRESULT value. Possible values include the following.
Return code |
Description |
S_OK |
No error. |
E_POINTER |
pszValue is not a valid pointer. |
E_INVALIDARG |
ccValue is not a valid value. |
E_ESF_BAD_PARAMETER |
The target parameter does not exist. |
E_ESF_OUT_OF_BOUND |
The target element of a collection is out of the bounds. |
E_ESF_INVALID_VALUE |
The parameter value is not allowed. |
Requirements
Header |
ESFilter.h |
Library |
ESFilter.dll |
MultiCam |
5.0 or later |