Edit

Share via

RpcMgmtEpEltInqNextA function (rpcdce.h)

  • Article

The RpcMgmtEpEltInqNext function returns one element from an endpoint map.

Syntax

RPC_STATUS RpcMgmtEpEltInqNextA(
  RPC_EP_INQ_HANDLE  InquiryContext,
  RPC_IF_ID          *IfId,
  RPC_BINDING_HANDLE *Binding,
  UUID               *ObjectUuid,
  RPC_CSTR           *Annotation
);

Parameters

InquiryContext

Specifies an inquiry context. The inquiry context is returned from RpcMgmtEpEltInqBegin.

IfId

Returns the interface identifier of the endpoint-map element.

Binding

Optional. Returns the binding handle from the endpoint-map element.

ObjectUuid

Optional. Returns the object UUID from the endpoint-map element.

Annotation

Optional. Returns the annotation string for the endpoint-map element. When there is no annotation string in the endpoint-map element, the empty string ("") is returned.

Return value

Value Meaning
RPC_S_OK
 The call succeeded.
 
Note  For a list of valid error codes, see RPC Return Values.
 

Remarks

The RpcMgmtEpEltInqNext function returns one element from the endpoint map. Elements selected depend on the inquiry context. The selection criteria are determined by InquiryType of the RpcMgmtEpEltInqBegin function that returned InquiryContext.

An application can view all the selected endpoint-map elements by repeatedly calling RpcMgmtEpEltInqNext. When all the elements have been viewed, this function returns an RPC_X_NO_MORE_ENTRIES status. The returned elements are unordered.

When the respective arguments are non-NULL, the RPC run-time function library allocates memory for Binding and Annotation on each call to this function. The application is responsible for calling RpcBindingFree for each returned Binding and RpcStringFree for each returned Annotation.

After viewing the endpoint-map elements, the application must call RpcMgmtEpEltInqDone to delete the inquiry context.

Note

The rpcdce.h header defines RpcMgmtEpEltInqNext as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header rpcdce.h (include Rpc.h)
Library Rpcrt4.lib
DLL Rpcrt4.dll

See also

RpcEpRegister

RpcMgmtEpEltInqBegin

RpcMgmtEpEltInqDone