WMS_CONTEXT_OPTIONS

  • Article

banner art

Previous Next

WMS_CONTEXT_OPTIONS

The WMS_CONTEXT_OPTIONS enumeration type indicates whether context values are specified and retrieved by value or by reference. This enumeration type is used by the IWMSContext interface.

Syntax

  typedef enum WMS_CONTEXT_OPTIONS{
  WMS_CONTEXT_SET_PROPERTY_NAME_BY_VALUE  = 0x0001,
  WMS_CONTEXT_SET_PROPERTY_STRING_BY_REFERENCE  = 0x0002,
  WMS_CONTEXT_GET_PROPERTY_STRING_BY_REFERENCE  = 0x0004
};

Members

WMS_CONTEXT_SET_PROPERTY_NAME_BY_VALUE

By default, when you use the IWMSContext interface to set a property in a context, the server assumes that you are passing the name of the property by reference. Use this constant to pass the name by value. For example, use this constant if you are creating temporary properties and adding them to an existing context. Do not use this constant if you identify a property by using any of the property names defined in Wmscontextnames.h and discussed in Contexts. If you do not use this constant and the server encounters a predefined property name, it uses the DEFINE_NAME macro (also defined in Wmscontextnames.h) to resolve the constant to a pointer to the string name of the property. For more information, see the methods of IWMSContext listed in the See Also sections at the end of this topic.

WMS_CONTEXT_SET_PROPERTY_STRING_BY_REFERENCE

By default, when you use the SetStringValue method on the IWMSContext interface to specify a string value for a context property, the server assumes that you are passing the string by value. Use this constant to pass a reference to the string instead. For example, use this constant if you use WMS_RTSP_PROTOCOL_NAME (defined in Wmscontextnames.h) to specify the RTSP protocol for the WMS_USER_CONTROL_PROTOCOL property in the user context. The server uses the DEFINE_NAME macro (also defined in Wmscontextnames.h) to resolve the constant to a pointer to a string that contains "RTSP".

WMS_CONTEXT_GET_PROPERTY_STRING_BY_REFERENCE

By default, when you use the GetStringValue method on the IWMSContext interface to retrieve a string value for a context property, the server assumes that you are retrieving the string by value. Use this constant to retrieve a reference to the string instead.

Requirements

Header: wmscontext.h.

Library: WMSServerTypeLib.dll.

Platform: Windows Server 2003 family, Windows Server 2008 family.

See Also (General)

See Also (Visual Basic .NET)

See Also (C#)

See Also (C++)

Previous Next