Locates the named parameter in the parameter bag and returns the value of the object it holds.
Namespace: FileNet.Api.Action
Assembly: FileNet.Api (in filenet.api.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Overridable Function GetIdValue( _ ByVal name As String _ ) As Id |
C# |
---|
public virtual Id GetIdValue( string name ) |
C++ |
---|
public: virtual Id GetIdValue( String name ) |
J# |
---|
public virtual Id GetIdValue( string name ) |
JScript |
---|
public virtual
function GetIdValue( name : String ) : Id |
Parameters
- name
- A
that specifies the parameter name to retrieve.String
Return Value
The value of the parameter as an
object. Returns
if the parameter cannot be found in the parameter bag.
Exceptions
Exception Type | Condition |
---|---|
API_INVALID_PROPERTY_TYPE | Thrown if the parameter is not of the type being requested. |