edmiRemoteGetHashedAttrInstances

EdmiError edmiRemoteGetHashedAttrInstances(SdaiServerContext serverContextId,    
                                           SdaiModel         modelId,      
                                           SdaiAttr          attrId,       
                                           SdaiString        attrStringValue,   
                                           SdaiInteger       attrIntegerValue,   
                                           SdaiInteger       maxBufferSize,       
                                           SdaiInteger       *index,              
                                           SdaiInteger       *numberOfHits,   
                                           SdaiInstance      *resultBuffer,    
                                           SdaiInvocationId  *edmiInvocationId);

Search the specified model for the instances with an attribute value equal to the specified attribute. Number of instances found is returned via the argument <numberOfHits>. If no attribute hash table is defined for the specified attribute, no sequential search is performed and the function returns an error code.

Arguments


TypeNameComment
SdaiServerContext

serverContextId

Context identification, from edmiDefineServerContext

SdaiModel

modelId

The modelId that uniquely identifies the edmModel in the remote EDMdatabase

SdaiAttr

attrId

A numeric attributeId that uniquely identifies the attribute in the remote  EDMdatabase

SdaiString

attrStringValue

If the attribute is of <string type>, use this argument to specify the attribute value to search for.

SdaiInteger

attrIntegerValue

If the attribute is of <integer type>, use this argument to specify the attribute value to search for.

SdaiInteger

maxBufferSize

The size of the buffer in which the indexes of all the matching aggregate elements will be returned. The number of returned indexes will never exceed this number.

SdaiInteger

*index

  • In: The index of the aggregate element to start reading from. The first element is indexed zero. Hence the legal index range is: [ 0 <= index < N ] , where N is the number of elements in the aggregate.
  • Out: The index of the "last returned matching element". If the return value is incremented by one, it may be used as input value for succeeding calls to the same function. This way, the second call will start reading aggregate elements where the first call finished. this will reduce the required size of the <resultBuffer>.
SdaiInteger

*numberOfHits

In: The maximum number of matching aggregate element indexes to return.If this number is greater than the limitation specified by the <maxBufferSize> argument, the maximum number of hits will be overruled by the value given in the <maxBufferSize> argument.
Out: The number of matching aggregate element indexes returned.

SdaiInstance

*resultBuffer

A buffer, allocated by the calling application, that will receive the indexes of the matching aggregate elements. Use the <maxBufferSize> argument to prevent writing past the end of this buffer.

SdaiInvocationId

*edmiInvocationId

Currently not used.

Return Value


Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'US:_r_EDMInterface'.

 

Options


  

 

Example


 

 

 

See also

Filter by label

There are no items with the selected labels at this time.

Â